dectris.albula.DImageOptionalData Class Reference

The DImageOptionalData class contains optional image parameters. These parameters may be set directly by filling out the return value of neXus(), or by using one of the convenience functions. E.g set_beam_center_x() sets "/entry/instrument/detector/beam_center_x". More...

Public Member Functions
def	beam_center_x ()
	x coordinate of the beam centre More...
def	set_beam_center_x (val)
	set x coordinate of the beam centre. More...
def	beam_center_y ()
	y coordinate of the beam centre More...
def	set_beam_center_y (val)
	Set y coordinate of the beam centre. More...
def	bit_depth_readout ()
	Bit depth of the readout file. More...
def	set_bit_depth_readout (val)
	Set bit depth of the readout file. More...
def	count_time ()
	Count or exposure time per image in seconds. More...
def	set_count_time (val)
	Set count time. More...
def	data_collection_date ()
	Data collection date. More...
def	set_data_collection_date (val)
	Set data collection date. More...
def	description ()
	Detector description. More...
def	set_description (val)
	Set detector description. More...
def	detector_number ()
	Detector serial number. More...
def	set_detector_number (val)
	Set detector number. More...
def	frame_time ()
	Frame time or exposure period per image in seconds. More...
def	set_frame_time (val)
	Set frame time. More...
def	saturation_value ()
	Saturation value or count cutoff. More...
def	set_saturation_value (val)
	Set saturation value. More...
def	sensor_material ()
	Material of the sensor e.g. More...
def	set_sensor_material (val)
	Set sensor material. More...
def	sensor_thickness ()
	Thickness of the sensor in m. More...
def	set_sensor_thickness (val)
	Set sensor thickness. More...
def	threshold_energy ()
	Threshold energy of the detector in eV. More...
def	set_threshold_energy (val)
	Set threshold energy. More...
def	gain_setting ()
	Gain Setting (e.g. More...
def	set_gain_setting (val)
	Set gain settings. More...
def	number_of_excluded_pixels ()
	Number of excluded pixels. More...
def	set_number_of_excluded_pixels (val)
	Set number of excluded pixels. More...
def	wavelength ()
	Wavelength of the beam in the case of monochromatic beam in Angstroem. More...
def	set_wavelength (val)
	Set wavelength in Angstroem. More...
def	x_pixel_size ()
	Width of a pixel in m. More...
def	set_x_pixel_size (val)
	Set width of pixel in m. More...
def	y_pixel_size ()
	Height of a pixel in m. More...
def	set_y_pixel_size (val)
	Set Height of pixel in m. More...
def	detector_distance ()
	Distance from the detector in m. More...
def	set_detector_distance (val)
	Set distance from the detector in m. More...
def	rotation_angle ()
	start angle in degree More...
def	set_rotation_angle (val)
	Set rotation_angle. More...
def	rotation_angle_step ()
	Angle increment in degree. More...
def	set_rotation_angle_step (val)
	Set rotation_angle_step. More...
def	filter_transmission ()
	Filter transmission. More...
def	set_filter_transmission (val)
	Set filter transmission. More...
def	beam_flux ()
	Beam flux in photons/s. More...
def	set_beam_flux (val)
	Set beam flux in photons/s. More...
def	polarisation ()
	Zero's component of polarisation vector. More...
def	set_polarisation (val)
	Set zero's component of polarisation vector. More...
def	modules ()
	List of detector modules. More...
def	set_modules (val)
	Set detector modules. More...
def	mode_register ()
	Mode register. More...
def	set_mode_register (val)
	Set mode register. More...
def	countrate_correction_bunch_mode ()
	Bunch mode for rate correction. More...
def	set_countrate_correction_bunch_mode (val)
	Set bunch mode for rate correction. More...
def	pixel_mask ()
	Pixel mask. More...
def	set_pixel_mask (pixel_mask)
	Set the pixel mask from a DImageInt object. More...
def	imageDescription ()
	Filename or something else describing the image. More...
def	setImageDescription (val)
	Set image description. More...
def	rawHeader ()
	Raw header, e.g. if the image has been read in from a tif file, the raw header is the first 4096 bytes of the file. More...
def	setRawHeader (val)
	set raw image header More...
def	neXus ()
	neXus() provides an interface to access the internal DNeXusTree object. More...
def	neXusIndex ()
	Index with respect to the underlying DNeXus object. More...
def	setNeXusIndex (index)
	setNeXusIndex() sets neXusIndex(). More...

Detailed Description

The DImageOptionalData class contains optional image parameters. These parameters may be set directly by filling out the return value of neXus(), or by using one of the convenience functions. E.g set_beam_center_x() sets "/entry/instrument/detector/beam_center_x".

Member Function Documentation

beam_center_x()

def dectris.albula.DImageOptionalData.beam_center_x

(

)

x coordinate of the beam centre

Returns

Float value stored in "/entry/instrument/detector/beam_center_x" of neXus().

beam_center_y()

def dectris.albula.DImageOptionalData.beam_center_y

(

)

y coordinate of the beam centre

Returns

Float value stored in "/entry/instrument/detector/beam_center_y" of neXus().

beam_flux()

def dectris.albula.DImageOptionalData.beam_flux

(

)

Beam flux in photons/s.

Returns

Float value stored in "/entry/instrument/beam/flux" of neXus().

bit_depth_readout()

def dectris.albula.DImageOptionalData.bit_depth_readout

(

)

Bit depth of the readout file.

Returns

Integer value stored in "entry/instrument/detector/bit_depth_readout" of neXus().

count_time()

def dectris.albula.DImageOptionalData.count_time

(

)

Count or exposure time per image in seconds.

Returns

Float value stored in "/entry/instrument/detector/count_time" of neXus().

countrate_correction_bunch_mode()

def dectris.albula.DImageOptionalData.countrate_correction_bunch_mode

(

)

Bunch mode for rate correction.

Returns

String value.

data_collection_date()

def dectris.albula.DImageOptionalData.data_collection_date

(

)

Data collection date.

Returns

String value stored in "/entry/instrument/detector/detectorSpecific/data_collection_date" of neXus().

description()

def dectris.albula.DImageOptionalData.description

(

)

Detector description.

Returns

String value stored in "/entry/instrument/detector/description" of neXus().

detector_distance()

def dectris.albula.DImageOptionalData.detector_distance

(

)

Distance from the detector in m.

Returns

Float value stored in "/entry/instrument/detector/detector_distance" of neXus().

detector_number()

def dectris.albula.DImageOptionalData.detector_number

(

)

Detector serial number.

Returns

String value stored in "/entry/instrument/detector/detector_number" of neXus().

filter_transmission()

def dectris.albula.DImageOptionalData.filter_transmission

(

)

Filter transmission.

Returns

Float value stored in "/entry/instrument/filter/transmission" of neXus().

frame_time()

def dectris.albula.DImageOptionalData.frame_time

(

)

Frame time or exposure period per image in seconds.

This is count time + readout time.

Returns

Float value stored in "/entry/instrument/detector/frame_time" of neXus().

gain_setting()

def dectris.albula.DImageOptionalData.gain_setting

(

)

Gain Setting (e.g.

"high gain").

Returns

String value stored in "/entry/instrument/detector/gain_setting" of neXus().

imageDescription()

def dectris.albula.DImageOptionalData.imageDescription

(

)

Filename or something else describing the image.

Returns

String value.

mode_register()

def dectris.albula.DImageOptionalData.mode_register

(

)

Mode register.

Returns

Integer value stored in "entry/instrument/detector/detectorSpecific/mode_register" of neXus().

modules()

def dectris.albula.DImageOptionalData.modules

(

)

List of detector modules.

Returns

List of DImageModule objects stored in "/entry/instrument/detector/detectorSpecific/detectorModule_xxx" of neXus().

neXus()

def dectris.albula.DImageOptionalData.neXus

(

)

neXus() provides an interface to access the internal DNeXusTree object.

Possible issue: As soon as an instance of DImageOptionalData goes out of scope its DNeXusTree is destroyed.

Returns

Reference to the internal DNeXusTree object

neXusIndex()

def dectris.albula.DImageOptionalData.neXusIndex

(

)

Index with respect to the underlying DNeXus object.

This parameter exists mainly for future convenience. For information on the image series that is stored as a field (maybe in future versions count_time) neXusIndex() points to the entry for the present image.

number_of_excluded_pixels()

def dectris.albula.DImageOptionalData.number_of_excluded_pixels

(

)

Number of excluded pixels.

Returns

Integer value stored in "/entry/instrument/detector/detectorSpecific/number_of_excluded_pixels" of neXus().

pixel_mask()

def dectris.albula.DImageOptionalData.pixel_mask

(

)

Pixel mask.

This is basically the value stored at "/entry/instrument/detector/detectorSpecific/pixel_mask" of neXus(). See also set_pixel_mask().

Returns

DImageInt or None if not set.

polarisation()

def dectris.albula.DImageOptionalData.polarisation

(

)

Zero's component of polarisation vector.

Returns

Float value. Zero's component of "/entry/instrument/beam/final_polarisation" of neXus().

rawHeader()

def dectris.albula.DImageOptionalData.rawHeader

(

)

Raw header, e.g. if the image has been read in from a tif file, the raw header is the first 4096 bytes of the file.

Returns

String value.

rotation_angle()

def dectris.albula.DImageOptionalData.rotation_angle

(

)

start angle in degree

Returns

Float or None

rotation_angle_step()

def dectris.albula.DImageOptionalData.rotation_angle_step

(

)

Angle increment in degree.

Returns

Float or None

saturation_value()

def dectris.albula.DImageOptionalData.saturation_value

(

)

Saturation value or count cutoff.

Maximum number of counts possible due to count rate limitation. Read cutof from "/entry/instrument/detector/detectorSpecific/countrate_correction_count_cutoff" or if not available from "/entry/instrument/detector/detectorSpecific/detectorModule_000/countrate_correction_count_cutoff"

Returns

Integer value stored in "/entry/instrument/detector/detectorSpecific/countrate_correction_count_cutoff" of neXus().

sensor_material()

def dectris.albula.DImageOptionalData.sensor_material

(

)

Material of the sensor e.g.

Si.

Returns

String value stored in "/entry/instrument/detector/sensor_material" of neXus().

sensor_thickness()

def dectris.albula.DImageOptionalData.sensor_thickness

(

)

Thickness of the sensor in m.

Returns

Float value stored in "/entry/instrument/detector/sensor_thickness" of neXus().

set_beam_center_x()

def dectris.albula.DImageOptionalData.set_beam_center_x

(

val

)

set x coordinate of the beam centre.

Sets "/entry/instrument/detector/beam_center_x" of neXus().

Parameters

val	Float or None

set_beam_center_y()

def dectris.albula.DImageOptionalData.set_beam_center_y

(

val

)

Set y coordinate of the beam centre.

Sets "/entry/instrument/detector/beam_center_y" of neXus().

Parameters

val	Float or None

set_beam_flux()

def dectris.albula.DImageOptionalData.set_beam_flux

(

val

)

Set beam flux in photons/s.

Sets "/entry/instrument/beam/flux" of neXus().

Parameters

val	Float or None

set_bit_depth_readout()

def dectris.albula.DImageOptionalData.set_bit_depth_readout

(

val

)

Set bit depth of the readout file.

Sets "entry/instrument/detector/bit_depth_readout" of neXus().

Parameters

val	Integer or None

set_count_time()

def dectris.albula.DImageOptionalData.set_count_time

(

val

)

Set count time.

Sets "/entry/instrument/detector/count_time" of neXus().

Parameters

val	Float or None

set_countrate_correction_bunch_mode()

def dectris.albula.DImageOptionalData.set_countrate_correction_bunch_mode

(

val

)

Set bunch mode for rate correction.

See imageDescription().

Parameters

val	String or None

set_data_collection_date()

def dectris.albula.DImageOptionalData.set_data_collection_date

(

val

)

Set data collection date.

Sets "/entry/instrument/detector/detectorSpecific/data_collection_date" of neXus().

Parameters

val	String or None

set_description()

def dectris.albula.DImageOptionalData.set_description

(

val

)

Set detector description.

Sets "/entry/instrument/detector/description" of neXus().

Parameters

val	String or None

set_detector_distance()

def dectris.albula.DImageOptionalData.set_detector_distance

(

val

)

Set distance from the detector in m.

Sets "/entry/instrument/detector/detector_distance" of neXus().

Parameters

val	Float or None

set_detector_number()

def dectris.albula.DImageOptionalData.set_detector_number

(

val

)

Set detector number.

Sets "/entry/instrument/detector/detector_number" of neXus(). Not taken into account into CBF mini header. Use set_description() instead.

Parameters

val	String or None

set_filter_transmission()

def dectris.albula.DImageOptionalData.set_filter_transmission

(

val

)

Set filter transmission.

Sets "/entry/instrument/filter/transmission" of neXus().

Parameters

val	Float or None

set_frame_time()

def dectris.albula.DImageOptionalData.set_frame_time

(

val

)

Set frame time.

Sets "/entry/instrument/detector/frame_time" of neXus().

Parameters

val	Float or None

set_gain_setting()

def dectris.albula.DImageOptionalData.set_gain_setting

(

val

)

Set gain settings.

Sets "/entry/instrument/detector/gain_setting" of neXus().

Parameters

val	String or None

set_mode_register()

def dectris.albula.DImageOptionalData.set_mode_register

(

val

)

Set mode register.

Sets "entry/instrument/detector/detectorSpecific/mode_register" of neXus().

Parameters

val	Integer or None

set_modules()

def dectris.albula.DImageOptionalData.set_modules

(

val

)

Set detector modules.

Sets "/entry/instrument/detector/detectorSpecific/detectorModule_xxx" of neXus().

Parameters

val	List of DImageModule objects or None

set_number_of_excluded_pixels()

def dectris.albula.DImageOptionalData.set_number_of_excluded_pixels

(

val

)

Set number of excluded pixels.

Sets "/entry/instrument/detector/detectorSpecific/number_of_excluded_pixels" of neXus().

Parameters

val	Integer >= 0 or None

set_pixel_mask()

def dectris.albula.DImageOptionalData.set_pixel_mask

(

pixel_mask

)

Set the pixel mask from a DImageInt object.

See also pixel_mask(). Sets "/entry/instrument/detector/detectorSpecific/pixel_mask" of neXus().

Parameters

pixel_mask

DImage or None, where pixel_mask.optionalData() is stripped off. If None the mask is unset.

set_polarisation()

def dectris.albula.DImageOptionalData.set_polarisation

(

val

)

Set zero's component of polarisation vector.

Sets zeros's component of "/entry/instrument/beam/final_polarisation" of neXus().

Parameters

val	Float or None

set_rotation_angle()

def dectris.albula.DImageOptionalData.set_rotation_angle

(

val

)

Set rotation_angle.

Parameters

val	Float or None

set_rotation_angle_step()

def dectris.albula.DImageOptionalData.set_rotation_angle_step

(

val

)

Set rotation_angle_step.

Parameters

val	Float or None

set_saturation_value()

def dectris.albula.DImageOptionalData.set_saturation_value

(

val

)

Set saturation value.

Sets "/entry/instrument/detector/detectorSpecific/countrate_correction_count_cutoff" of neXus().

Parameters

val	Integer or None

set_sensor_material()

def dectris.albula.DImageOptionalData.set_sensor_material

(

val

)

Set sensor material.

Sets "/entry/instrument/detector/sensor_material" of neXus().

Parameters

val	String or None

set_sensor_thickness()

def dectris.albula.DImageOptionalData.set_sensor_thickness

(

val

)

Set sensor thickness.

Sets "/entry/instrument/detector/sensor_thickness" of neXus().

Parameters

val	Float or None

set_threshold_energy()

def dectris.albula.DImageOptionalData.set_threshold_energy

(

val

)

Set threshold energy.

Sets "/entry/instrument/detector/threshold_energy" of neXus().

Parameters

val	Float or None

set_wavelength()

def dectris.albula.DImageOptionalData.set_wavelength

(

val

)

Set wavelength in Angstroem.

Sets "/entry/instrument/beam/incident_wavelength" of neXus().

Parameters

val	Float or None

set_x_pixel_size()

def dectris.albula.DImageOptionalData.set_x_pixel_size

(

val

)

Set width of pixel in m.

Sets "/entry/instrument/detector/x_pixel_size" of neXus().

Parameters

val	Float or None

set_y_pixel_size()

def dectris.albula.DImageOptionalData.set_y_pixel_size

(

val

)

Set Height of pixel in m.

Sets "/entry/instrument/detector/y_pixel_size" of neXus().

Parameters

val	Float or None

setImageDescription()

def dectris.albula.DImageOptionalData.setImageDescription

(

val

)

Set image description.

See imageDescription().

Parameters

val	String or None

setNeXusIndex()

def dectris.albula.DImageOptionalData.setNeXusIndex

(

index

)

setNeXusIndex() sets neXusIndex().

Parameters

index

Integer

setRawHeader()

def dectris.albula.DImageOptionalData.setRawHeader

(

val

)

set raw image header

Parameters

val	String or None

threshold_energy()

def dectris.albula.DImageOptionalData.threshold_energy

(

)

Threshold energy of the detector in eV.

Returns

Float value stored in "/entry/instrument/detector/threshold_energy" of neXus().

wavelength()

def dectris.albula.DImageOptionalData.wavelength

(

)

Wavelength of the beam in the case of monochromatic beam in Angstroem.

Returns

Float value stored in "/entry/instrument/beam/incident_wavelength" of neXus().

x_pixel_size()

def dectris.albula.DImageOptionalData.x_pixel_size

(

)

Width of a pixel in m.

Returns

Float value stored in "/entry/instrument/detector/x_pixel_size" of neXus().

y_pixel_size()

def dectris.albula.DImageOptionalData.y_pixel_size

(

)

Height of a pixel in m.

Returns

Float value stored in "/entry/instrument/detector/y_pixel_size" of neXus().