hikari.scripts.angular_explorer

This file contains tools for making property maps visualised on sphere

Attributes

angular_property_explorer_factory

Classes

`AngularPropertyExplorerFactory`	A factory method for creating angular property explorers.
`AngularPropertyExplorer`	An abstract base class for objects handling analysing parameters as
`AngularPotencyExplorer`	An abstract base class for objects handling analysing parameters as
`AngularR1Explorer`	An abstract base class for objects handling analysing parameters as

Module Contents

class hikari.scripts.angular_explorer.AngularPropertyExplorerFactory[source]

A factory method for creating angular property explorers.

_explorers

register(prop, explorer)[source]

create(prop, **kwargs)[source]

class hikari.scripts.angular_explorer.AngularPropertyExplorer[source]

An abstract base class for objects handling analysing parameters as a function of crystal orientation in a Diamond Anvil Cell. In order to generate a map of desired property, the following methods must be executed in order:

set_path
set_sample
set_output
explore

hkl_is_read_not_generated: bool

property_name: str

property_theoretical_limits: hikari.utility.Interval

GNUPLOT_INPUT_EXTENSION = '.gnu'

GNUPLOT_OUTPUT_EXTENSION = '.pnG'

HISTOGRAM_EXTENSION = '.his'

HKL_EXTENSION = '.hkl'

LISTING_EXTENSION = '.lst'

MATPLOTLIB_EXTENSION = '.png'

MESH_EXTENSION = '.dat'

POLAR_LIMIT_DICT

AZIMUTH_LIMIT_DICT

_path = ''

_sg

_pg

_lg

_th_limits

_ph_limits

axis = ''

hkl_frame

opening_angle = 0.0

orientation = None

resolution = 0.0

fix_scale = False

histogram = False

output_quality = 1

data_dict

set_up(a, b, c, al, be, ga, space_group, wavelength, axis, opening_angle, orientation, resolution, path, fix_scale, histogram, output_quality)[source]

abstract explore()[source]: Main interface method which, apart from the setters, is run within the script itself and generates data and figures using class methods

property prop_limits

write_hist_file()[source]

_make_hkl_frame()[source]: Make ball or axis of hkl which will be cut in further steps

_read_hkl_frame(hkl_format)[source]: Read reflections of hkl which will be cut in further steps

property th_limits: Interval range of polar angle where property will be calculated

property ph_limits: Interval range of azimuth angle where property will be calculated

_draw_map(artist, extension)[source]

draw_matplotlib_map()[source]

draw_gnuplot_map()[source]

property angle_res

property path: Provides path = directory + stem to the workspace. They are common to all input and output files, the extensions are specified as class var.

property sg

property pg

property lg

property focus_cartesian

property focus_spherical_closest

property prop_at_focus_closest

property th_range

property ph_range

property th_comb

property ph_comb

property th_mesh

property ph_mesh

orientation_weights(th, ph)[source]: Calculate how much each point should contribute to distribution

property descriptive_statistics_string

property prop_at_focus_string

class hikari.scripts.angular_explorer.AngularPotencyExplorer[source]

Bases: AngularPropertyExplorer

An abstract base class for objects handling analysing parameters as a function of crystal orientation in a Diamond Anvil Cell. In order to generate a map of desired property, the following methods must be executed in order:

set_path
set_sample
set_output
explore

hkl_is_read_not_generated = False

property_name = 'potency'

property_theoretical_limits

explore()[source]: Main interface method which, apart from the setters, is run within the script itself and generates data and figures using class methods

class hikari.scripts.angular_explorer.AngularR1Explorer[source]

Bases: AngularPropertyExplorer

An abstract base class for objects handling analysing parameters as a function of crystal orientation in a Diamond Anvil Cell. In order to generate a map of desired property, the following methods must be executed in order:

set_path
set_sample
set_output
explore

hkl_is_read_not_generated = True

property_name = 'R1'

property_theoretical_limits

explore()[source]: Main interface method which, apart from the setters, is run within the script itself and generates data and figures using class methods

hikari.scripts.angular_explorer.angular_property_explorer_factory