artist.util.config_dictionary
=============================

.. py:module:: artist.util.config_dictionary


Attributes
----------

.. autoapisummary::

   artist.util.config_dictionary.power_plant_position
   artist.util.config_dictionary.target_area_geometry
   artist.util.config_dictionary.target_area_position_center
   artist.util.config_dictionary.target_area_normal_vector
   artist.util.config_dictionary.target_area_plane_e
   artist.util.config_dictionary.target_area_plane_u
   artist.util.config_dictionary.target_area_curvature_e
   artist.util.config_dictionary.target_area_curvature_u
   artist.util.config_dictionary.target_area_receiver
   artist.util.config_dictionary.target_area_type_planar
   artist.util.config_dictionary.light_source_type
   artist.util.config_dictionary.sun_key
   artist.util.config_dictionary.light_source_number_of_rays
   artist.util.config_dictionary.light_source_distribution_parameters
   artist.util.config_dictionary.light_source_distribution_type
   artist.util.config_dictionary.light_source_distribution_is_normal
   artist.util.config_dictionary.light_source_mean
   artist.util.config_dictionary.light_source_covariance
   artist.util.config_dictionary.facets_key
   artist.util.config_dictionary.facet_control_points
   artist.util.config_dictionary.facet_degrees
   artist.util.config_dictionary.facet_number_of_evaluation_points
   artist.util.config_dictionary.facets_translation_vector
   artist.util.config_dictionary.facets_canting
   artist.util.config_dictionary.first_joint_translation_e
   artist.util.config_dictionary.first_joint_translation_n
   artist.util.config_dictionary.first_joint_translation_u
   artist.util.config_dictionary.first_joint_tilt_n
   artist.util.config_dictionary.first_joint_tilt_u
   artist.util.config_dictionary.second_joint_translation_e
   artist.util.config_dictionary.second_joint_translation_n
   artist.util.config_dictionary.second_joint_translation_u
   artist.util.config_dictionary.second_joint_tilt_e
   artist.util.config_dictionary.second_joint_tilt_n
   artist.util.config_dictionary.concentrator_translation_e
   artist.util.config_dictionary.concentrator_translation_n
   artist.util.config_dictionary.concentrator_translation_u
   artist.util.config_dictionary.kinematic_type
   artist.util.config_dictionary.rigid_body_key
   artist.util.config_dictionary.rigid_body_number_of_translation_deviation_parameters
   artist.util.config_dictionary.rigid_body_number_of_rotation_deviation_parameters
   artist.util.config_dictionary.rigid_body_number_of_actuators
   artist.util.config_dictionary.kinematic_initial_orientation
   artist.util.config_dictionary.kinematic_deviations
   artist.util.config_dictionary.translation_deviations
   artist.util.config_dictionary.rotation_deviations
   artist.util.config_dictionary.actuator_clockwise_axis_movement
   artist.util.config_dictionary.actuator_increment
   artist.util.config_dictionary.actuator_min_max_motor_positions
   artist.util.config_dictionary.actuator_initial_stroke_length
   artist.util.config_dictionary.actuator_offset
   artist.util.config_dictionary.actuator_pivot_radius
   artist.util.config_dictionary.actuator_initial_angle
   artist.util.config_dictionary.actuator_type_key
   artist.util.config_dictionary.actuator_parameters_key
   artist.util.config_dictionary.ideal_actuator_key
   artist.util.config_dictionary.ideal_actuator_int
   artist.util.config_dictionary.linear_actuator_key
   artist.util.config_dictionary.linear_actuator_int
   artist.util.config_dictionary.surface_prototype_key
   artist.util.config_dictionary.kinematic_prototype_key
   artist.util.config_dictionary.actuators_prototype_key
   artist.util.config_dictionary.heliostat_id
   artist.util.config_dictionary.heliostat_position
   artist.util.config_dictionary.heliostat_aim_point
   artist.util.config_dictionary.heliostat_surface_key
   artist.util.config_dictionary.heliostat_kinematic_key
   artist.util.config_dictionary.heliostat_actuator_key
   artist.util.config_dictionary.prototype_key
   artist.util.config_dictionary.power_plant_key
   artist.util.config_dictionary.target_area_key
   artist.util.config_dictionary.light_source_key
   artist.util.config_dictionary.heliostat_key
   artist.util.config_dictionary.fit_nurbs_from_points
   artist.util.config_dictionary.fit_nurbs_from_normals
   artist.util.config_dictionary.kinematic_reconstruction_raytracing
   artist.util.config_dictionary.names
   artist.util.config_dictionary.positions
   artist.util.config_dictionary.aim_points
   artist.util.config_dictionary.surface_points
   artist.util.config_dictionary.surface_normals
   artist.util.config_dictionary.initial_orientations
   artist.util.config_dictionary.kinematic_deviation_parameters
   artist.util.config_dictionary.actuator_parameters_non_optimizable
   artist.util.config_dictionary.actuator_parameters_optimizable
   artist.util.config_dictionary.heliostat_group_type
   artist.util.config_dictionary.paint_increment
   artist.util.config_dictionary.paint_initial_stroke_length
   artist.util.config_dictionary.paint_offset
   artist.util.config_dictionary.paint_pivot_radius
   artist.util.config_dictionary.paint_initial_angle
   artist.util.config_dictionary.paint_actuator_type
   artist.util.config_dictionary.paint_clockwise_axis_movement
   artist.util.config_dictionary.paint_min_increment
   artist.util.config_dictionary.paint_max_increment
   artist.util.config_dictionary.linux
   artist.util.config_dictionary.windows
   artist.util.config_dictionary.mac
   artist.util.config_dictionary.number_of_heliostat_groups
   artist.util.config_dictionary.utis_crop_width
   artist.util.config_dictionary.utis_crop_height
   artist.util.config_dictionary.data_parser
   artist.util.config_dictionary.paint
   artist.util.config_dictionary.heliostat_data_mapping
   artist.util.config_dictionary.initial_learning_rate
   artist.util.config_dictionary.tolerance
   artist.util.config_dictionary.max_epoch
   artist.util.config_dictionary.log_step
   artist.util.config_dictionary.early_stopping_delta
   artist.util.config_dictionary.early_stopping_patience
   artist.util.config_dictionary.scheduler
   artist.util.config_dictionary.scheduler_parameters
   artist.util.config_dictionary.exponential
   artist.util.config_dictionary.cyclic
   artist.util.config_dictionary.reduce_on_plateau
   artist.util.config_dictionary.gamma
   artist.util.config_dictionary.min
   artist.util.config_dictionary.max
   artist.util.config_dictionary.step_size_up
   artist.util.config_dictionary.reduce_factor
   artist.util.config_dictionary.patience
   artist.util.config_dictionary.threshold
   artist.util.config_dictionary.cooldown
   artist.util.config_dictionary.regularizers
   artist.util.config_dictionary.regularization_callable
   artist.util.config_dictionary.weight
   artist.util.config_dictionary.regularizers_parameters
   artist.util.config_dictionary.vector_loss
   artist.util.config_dictionary.total_variation_loss
   artist.util.config_dictionary.ideal_surface_loss
   artist.util.config_dictionary.total_variation_loss_points
   artist.util.config_dictionary.total_variation_loss_normals
   artist.util.config_dictionary.number_of_neighbors
   artist.util.config_dictionary.sigma
   artist.util.config_dictionary.device
   artist.util.config_dictionary.is_distributed
   artist.util.config_dictionary.is_nested
   artist.util.config_dictionary.rank
   artist.util.config_dictionary.world_size
   artist.util.config_dictionary.process_subgroup
   artist.util.config_dictionary.groups_to_ranks_mapping
   artist.util.config_dictionary.heliostat_group_rank
   artist.util.config_dictionary.heliostat_group_world_size
   artist.util.config_dictionary.ranks_to_groups_mapping


Module Contents
---------------

.. py:data:: power_plant_position
   :value: 'position'


   Key to access the power plant position.


.. py:data:: target_area_geometry
   :value: 'geometry'


   Key to access the target area type.


.. py:data:: target_area_position_center
   :value: 'position_center'


   Key to access the target area center position.


.. py:data:: target_area_normal_vector
   :value: 'normal_vector'


   Key to access the target area normal vector.


.. py:data:: target_area_plane_e
   :value: 'plane_e'


   Key to access the target area plane in the east direction.


.. py:data:: target_area_plane_u
   :value: 'plane_u'


   Key to access the target area plane in the up direction.


.. py:data:: target_area_curvature_e
   :value: 'curvature_e'


   Key to access the target area curvature in the east direction.


.. py:data:: target_area_curvature_u
   :value: 'curvature_u'


   Key to access the target area curvature in the up direction.


.. py:data:: target_area_receiver
   :value: 'receiver'


   Key used to define that the target area is a receiver.


.. py:data:: target_area_type_planar
   :value: 'planar'


   Key used to define that a planar target area type is used.


.. py:data:: light_source_type
   :value: 'type'


   Key to access the light source type.


.. py:data:: sun_key
   :value: 'sun'


   Key to define that the light source type is a sun.


.. py:data:: light_source_number_of_rays
   :value: 'number_of_rays'


   Key to access the number of rays for the light source.


.. py:data:: light_source_distribution_parameters
   :value: 'distribution_parameters'


   Key to access the light source distribution parameters.


.. py:data:: light_source_distribution_type
   :value: 'distribution_type'


   Key to access the light source distribution type.


.. py:data:: light_source_distribution_is_normal
   :value: 'normal'


   Key to define that the light source distribution is modelled by a multivariate normal distribution.


.. py:data:: light_source_mean
   :value: 'mean'


   Key to access the mean for the light source distribution.


.. py:data:: light_source_covariance
   :value: 'covariance'


   Key to access the covariance for the light source distribution.


.. py:data:: facets_key
   :value: 'facets'


   Key to access the facets.


.. py:data:: facet_control_points
   :value: 'control_points'


   Key to access the facet control points.


.. py:data:: facet_degrees
   :value: 'degrees'


   Key to access the facet degrees in the east and north direction.


.. py:data:: facet_number_of_evaluation_points
   :value: 'number_of_evaluation_points'


   Key to access the facet number of evaluation points in the east and north direction.


.. py:data:: facets_translation_vector
   :value: 'position'


   Key to access the translation vector indicating the position of the facet relative to the center of the heliostat.


.. py:data:: facets_canting
   :value: 'canting'


   Key to access the facet canting in the east and north direction.


.. py:data:: first_joint_translation_e
   :value: 'first_joint_translation_e'


   Key to access the kinematic first joint translation in the east direction.


.. py:data:: first_joint_translation_n
   :value: 'first_joint_translation_n'


   Key to access the kinematic first joint translation in the north direction.


.. py:data:: first_joint_translation_u
   :value: 'first_joint_translation_u'


   Key to access the kinematic first joint translation in the up direction.


.. py:data:: first_joint_tilt_n
   :value: 'first_joint_tilt_n'


   Key to access the kinematic first joint tilt in the north direction.


.. py:data:: first_joint_tilt_u
   :value: 'first_joint_tilt_u'


   Key to access the kinematic first joint tilt in the up direction.


.. py:data:: second_joint_translation_e
   :value: 'second_joint_translation_e'


   Key to access the kinematic second joint translation in the east direction.


.. py:data:: second_joint_translation_n
   :value: 'second_joint_translation_n'


   Key to access the kinematic second joint translation in the north direction.


.. py:data:: second_joint_translation_u
   :value: 'second_joint_translation_u'


   Key to access the kinematic second joint translation in the up direction.


.. py:data:: second_joint_tilt_e
   :value: 'second_joint_tilt_e'


   Key to access the kinematic second joint tilt in the east direction.


.. py:data:: second_joint_tilt_n
   :value: 'second_joint_tilt_n'


   Key to access the kinematic second joint tilt in the north direction.


.. py:data:: concentrator_translation_e
   :value: 'concentrator_translation_e'


   Key to access the kinematic concentrator translation in the east direction.


.. py:data:: concentrator_translation_n
   :value: 'concentrator_translation_n'


   Key to access the kinematic concentrator translation in the north direction.


.. py:data:: concentrator_translation_u
   :value: 'concentrator_translation_u'


   Key to access the kinematic concentrator translation in the up direction.


.. py:data:: kinematic_type
   :value: 'type'


   Key to access the kinematic type.


.. py:data:: rigid_body_key
   :value: 'rigid_body'


   Key to define that the rigid body kinematic is used as a kinematic type.


.. py:data:: rigid_body_number_of_translation_deviation_parameters
   :value: 9


   Number of translation deviation parameters used in the rigid body kinematic.


.. py:data:: rigid_body_number_of_rotation_deviation_parameters
   :value: 4


   Number of rotation deviation parameters used in the rigid body kinematic.


.. py:data:: rigid_body_number_of_actuators
   :value: 2


   Number of actuators used in the rigid body kinematic.


.. py:data:: kinematic_initial_orientation
   :value: 'initial_orientation'


   Key to access the initial orientation.


.. py:data:: kinematic_deviations
   :value: 'deviations'


   Key to access the kinematic deviations.


.. py:data:: translation_deviations
   :value: 'translation_deviations'


   Key to access the kinematic translation deviations.


.. py:data:: rotation_deviations
   :value: 'rotation_deviations'


   Key to access the kinematic rotation deviations.


.. py:data:: actuator_clockwise_axis_movement
   :value: 'clockwise_axis_movement'


   Key to access the actuator clockwise parameter.


.. py:data:: actuator_increment
   :value: 'increment'


   Key to access the actuator increment parameter.


.. py:data:: actuator_min_max_motor_positions
   :value: 'min_max_motor_positions'


   Key to access the minimum and maximum motor positions of an actuator.


.. py:data:: actuator_initial_stroke_length
   :value: 'initial_stroke_length'


   Key to access the actuator initial stroke length parameter.


.. py:data:: actuator_offset
   :value: 'offset'


   Key to access the actuator offset parameter.


.. py:data:: actuator_pivot_radius
   :value: 'pivot_radius'


   Key to access the actuator pivot radius parameter.


.. py:data:: actuator_initial_angle
   :value: 'initial_angle'


   Key to access the actuator initial angle parameter.


.. py:data:: actuator_type_key
   :value: 'type'


   Key to access the actuator type.


.. py:data:: actuator_parameters_key
   :value: 'parameters'


   Key to access the actuator parameters.


.. py:data:: ideal_actuator_key
   :value: 'ideal'


   Key defining that the actuator used is an ideal actuator.


.. py:data:: ideal_actuator_int
   :value: 1


   Int defining that the actuator used is an ideal actuator.


.. py:data:: linear_actuator_key
   :value: 'linear'


   Int defining that the actuator used is a linear actuator.


.. py:data:: linear_actuator_int
   :value: 0


.. py:data:: surface_prototype_key
   :value: 'surface'


   Key to access the surface prototype.


.. py:data:: kinematic_prototype_key
   :value: 'kinematic'


   Key to access the kinematic prototype.


.. py:data:: actuators_prototype_key
   :value: 'actuator'


   Key to access the actuators prototype.


.. py:data:: heliostat_id
   :value: 'id'


   Key to access the heliostat ID.


.. py:data:: heliostat_position
   :value: 'position'


   Key to access the heliostat position.


.. py:data:: heliostat_aim_point
   :value: 'aim_point'


   Key to access the heliostat aim point.


.. py:data:: heliostat_surface_key
   :value: 'surface'


   Key to access the heliostat surface.


.. py:data:: heliostat_kinematic_key
   :value: 'kinematic'


   Key to access the heliostat kinematic.


.. py:data:: heliostat_actuator_key
   :value: 'actuator'


   Key to access the heliostat actuator.


.. py:data:: prototype_key
   :value: 'prototypes'


   Key to access the prototypes.


.. py:data:: power_plant_key
   :value: 'power_plant'


   Key to access the power plant.


.. py:data:: target_area_key
   :value: 'target_areas'


   Key to access the target areas.


.. py:data:: light_source_key
   :value: 'lightsources'


   Key to access the light sources.


.. py:data:: heliostat_key
   :value: 'heliostats'


   Key to access the heliostats.


.. py:data:: fit_nurbs_from_points
   :value: 'point_cloud'


   Defines that the NURBS should be learnt using a point cloud.


.. py:data:: fit_nurbs_from_normals
   :value: 'deflectometry'


   Defines that the NURBS should be learnt using deflectometry data.


.. py:data:: kinematic_reconstruction_raytracing
   :value: 'raytracing'


   Defines that the kinematic reconstructor uses ray tracing.


.. py:data:: names
   :value: 'names'


   Key to access heliostat names.


.. py:data:: positions
   :value: 'positions'


   Key to access heliostat positions.


.. py:data:: aim_points
   :value: 'aim_points'


   Key to access heliostat aim_points.


.. py:data:: surface_points
   :value: 'surface_points'


   Key to access surface points.


.. py:data:: surface_normals
   :value: 'surface_normals'


   Key to access surface normals.


.. py:data:: initial_orientations
   :value: 'initial_orientations'


   Key to access initial orientations of heliostats.


.. py:data:: kinematic_deviation_parameters
   :value: 'kinematic_deviation_parameters'


   Key to access kinematic deviation parameters of heliostats.


.. py:data:: actuator_parameters_non_optimizable
   :value: 'actuator_parameters_non_optimizable'


   Key to access non-optimizable actuator parameters of heliostats.


.. py:data:: actuator_parameters_optimizable
   :value: 'actuator_parameters_optimizable'


   Key to access optimizable actuator parameters of heliostats.


.. py:data:: heliostat_group_type
   :value: 'type'


   Key to access the heliostat group type.


.. py:data:: paint_increment
   :value: 'increment'


   Key to access the actuators increment in a ``PAINT`` heliostat_properties.json file.


.. py:data:: paint_initial_stroke_length
   :value: 'initial_stroke_length'


   Key to access the actuators initial stroke length in a ``PAINT`` heliostat_properties.json file.


.. py:data:: paint_offset
   :value: 'offset'


   Key to access the actuators offset in a ``PAINT`` heliostat_properties.json file.


.. py:data:: paint_pivot_radius
   :value: 'pivot_radius'


   Key to access the actuators pivot radius in a ``PAINT`` heliostat_properties.json file.


.. py:data:: paint_initial_angle
   :value: 'initial_angle'


   Key to access the actuators initial angle in a ``PAINT`` heliostat_properties.json file.


.. py:data:: paint_actuator_type
   :value: 'type_axis'


   Key to access the actuator type in a ``PAINT`` heliostat_properties.json file.


.. py:data:: paint_clockwise_axis_movement
   :value: 'clockwise_axis_movement'


   Key to access the actuators axis movement direction in a ``PAINT`` heliostat_properties.json file.


.. py:data:: paint_min_increment
   :value: 'min_increment'


   Key to access the actuators minimum increment in a ``PAINT`` heliostat_properties.json file.


.. py:data:: paint_max_increment
   :value: 'max_increment'


   Key to access the actuators maximum increment in a ``PAINT`` heliostat_properties.json file.


.. py:data:: linux
   :value: 'Linux'


   Key to access the Linux OS name.


.. py:data:: windows
   :value: 'Windows'


   Key to access the Windows OS name.


.. py:data:: mac
   :value: 'Darwin'


   Key to access the Mac OS name.


.. py:data:: number_of_heliostat_groups
   :value: 'number_of_heliostat_groups'


   Key to access the number of heliostat groups for distributed setup.


.. py:data:: utis_crop_width
   :value: 6


   Key to access the crop width used in utis.


.. py:data:: utis_crop_height
   :value: 6


   Key to access the crop height used in utis.


.. py:data:: data_parser
   :value: 'data_parser'


   Key to access a data parser.


.. py:data:: paint
   :value: 'paint'


   Key to access the name ``paint``.


.. py:data:: heliostat_data_mapping
   :value: 'heliostat_data_mapping'


   Key to access a heliostat data mapping.


.. py:data:: initial_learning_rate
   :value: 'initial_learning_rate'


   Key to access the initial learning rate of an optimizer.


.. py:data:: tolerance
   :value: 'tolerance'


   Key to access the tolerance of an optimization.


.. py:data:: max_epoch
   :value: 'max_epoch'


   Key to access the maximum epoch number of an optimization.


.. py:data:: log_step
   :value: 'log_step'


   Key to access the step for log statements of an optimization.


.. py:data:: early_stopping_delta
   :value: 'early_stopping_delta'


   Key to access the early stopping delta of an optimization.


.. py:data:: early_stopping_patience
   :value: 'early_stopping_patience'


   Key to access the early stopping patience of an optimization.


.. py:data:: scheduler
   :value: 'scheduler'


   Key to access the name of a learning rate scheduler.


.. py:data:: scheduler_parameters
   :value: 'scheduler_parameters'


   Key to access the learning rate scheduler parameters.


.. py:data:: exponential
   :value: 'exponential'


   Key to access an exponential learning rate scheduler.


.. py:data:: cyclic
   :value: 'cyclic'


   Key to access a cyclic learning rate scheduler.


.. py:data:: reduce_on_plateau
   :value: 'reduce_on_plateau'


   Key to access a reduce on plateau learning rate scheduler.


.. py:data:: gamma
   :value: 'gamma'


   Key to access gamma of an exponential learning rate scheduler.


.. py:data:: min
   :value: 'min'


   Key to access the minimum learning rate of a learning rate scheduler.


.. py:data:: max
   :value: 'max'


   Key to access the maximum learning rate of a learning rate scheduler.


.. py:data:: step_size_up
   :value: 'step_size_up'


   Key to access the step size up parameter of a cyclic learning rate scheduler.


.. py:data:: reduce_factor
   :value: 'reduce_factor'


   Key to access the reduce factor of a reduce on plateau learning rate scheduler.


.. py:data:: patience
   :value: 'patience'


   Key to access the patience of a reduce on plateau learning rate scheduler.


.. py:data:: threshold
   :value: 'threshold'


   Key to access the threshold of a reduce on plateau learning rate scheduler.


.. py:data:: cooldown
   :value: 'cooldown'


   Key to access the cooldown parameter of a reduce on plateau learning rate scheduler.


.. py:data:: regularizers
   :value: 'regularizers'


   Key to access regularizers.


.. py:data:: regularization_callable
   :value: 'regularization_callable'


   Key to access the callable name of a regularizer.


.. py:data:: weight
   :value: 'weight'


   Key to access the weight of a regularizer.


.. py:data:: regularizers_parameters
   :value: 'regularizers_parameters'


   Key to access the parameters of a regularizer.


.. py:data:: vector_loss
   :value: 'vector_loss'


   Key to access the vector loss function.


.. py:data:: total_variation_loss
   :value: 'total_variation_loss'


   Key to access the total variation loss function.


.. py:data:: ideal_surface_loss
   :value: 'ideal_surface_loss'


   Key to access the ideal surface loss regularizer.


.. py:data:: total_variation_loss_points
   :value: 'total_variation_loss_points'


   Key to access the total variation loss regularizer for surface points.


.. py:data:: total_variation_loss_normals
   :value: 'total_variation_loss_normals'


   Key to access the total variation loss regularizer for surface normals.


.. py:data:: number_of_neighbors
   :value: 'number_of_neighbors'


   Key to access the number of neighbors parameter of a regularizer.


.. py:data:: sigma
   :value: 'sigma'


   Key to access the sigma parameter of a regularizer.


.. py:data:: device
   :value: 'device'


   Key to access the device.


.. py:data:: is_distributed
   :value: 'is_distributed'


   Flag for the distributed setup.


.. py:data:: is_nested
   :value: 'is_nested'


   Flag for the nested distributed setup.


.. py:data:: rank
   :value: 'rank'


   Key to access the rank in a ddp setup.


.. py:data:: world_size
   :value: 'world_size'


   Key to access the world size in a ddp setup.


.. py:data:: process_subgroup
   :value: 'process_subgroup'


   Key to access the process subgroup in a ddp setup.


.. py:data:: groups_to_ranks_mapping
   :value: 'groups_to_ranks_mapping'


   Key to access the mapping from heliostat groups to ranks.


.. py:data:: heliostat_group_rank
   :value: 'heliostat_group_rank'


   Key to access the rank within a process subgroups.


.. py:data:: heliostat_group_world_size
   :value: 'heliostat_group_world_size'


   Key to access the world size within a process subgroups.


.. py:data:: ranks_to_groups_mapping
   :value: 'ranks_to_groups_mapping'


   Key to access the mapping from ranks to heliostat groups.