syned.beamline.shape.ParabolicCylinder

class syned.beamline.shape.ParabolicCylinder(parabola_parameter=0.0, at_infinity=0, pole_to_focus=None, convexity=0, cylinder_direction=0)[source]

Constructor.

Parameters:

parabola_parameter (float, optional) – parabola_parameter = 2 * focal_distance = - 0.5 * ccc_9 / ccc_2.
at_infinity (int (as defined by Side), optional) – SOURCE = 0, IMAGE = 1.
pole_to_focus (float, optional) – The p distance.
convexity (int (as defined by Convexity), optional) – NONE = -1, UPWARD = 0, DOWNWARD = 1.
cylinder_direction (int (as defined by Direction), optional) – TANGENTIAL = 0, SAGITTAL = 1.

__init__(parabola_parameter=0.0, at_infinity=0, pole_to_focus=None, convexity=0, cylinder_direction=0)[source]

Methods

`__init__`([parabola_parameter, at_infinity, ...])
`create_parabolic_cylinder_from_p_q`([p, q, ...])	Returns a ParabolicCylinder instance from factory parameters.
`create_parabolic_cylinder_from_parabola_parameter`([...])	Returns a ParabolicCylinder instance.
`create_paraboloid_from_p_q`([p, q, ...])	Creates a paraboloid from the factory parameters.
`create_paraboloid_from_parabola_parameter`([...])	Create a paraboloid.
`duplicate`()	Returns a copy of the SYNED object instance.
`from_hex_tring`(hex_string)
`get_at_infinity`()	Returns the "at_infinity" flag.
`get_convexity`()	Gets the convexity flag.
`get_cylinder_direction`()	Returns the cylinder direction.
`get_grazing_angle`()	Returns the grazing angle.
`get_parabola_parameter`()	Returns the parabola parameter.
`get_parabola_parameter_from_p_q`([p, q, ...])	Calculates the parabola parameter from the factory parameters.
`get_pole_to_focus`()	Returns the distance from focus to pole.
`get_value_from_key_name`(key)	Gets a value using its key value.
`info`()	Get text info of recurrent SYNED objects.
`info_recurrent`(fd[, prefix])	Get text info of recurrent SYNED objects.
`initialize_from_p_q`([p, q, grazing_angle, ...])	Sets the parameters calculated from factory parameters.
`keys`()	Returns the keys of the supporting doctionary.
`set_value_from_key_name`(key, value)	Sets a value using its key value.
`to_dictionary`()	Returns a dictionary with the object fields.
`to_full_dictionary`()	Returns a dictionary with the object fields, including other syned objects embedded or list of elements.
`to_hex_tring`()
`to_json`([file_name])	Writes a json file with the SYNED object data.