fpipy.conventions

Conventions for data, coordinate and attribute names.

fpipy.conventions.RGB_dims = ('y', 'x', 'colour')

Convention for RGB images.

fpipy.conventions.band_index = 'band'

Index for wavelength band data.

fpipy.conventions.camera_exposure = 'exposure'

Camera exposure time in milliseconds.

fpipy.conventions.camera_gain = 'gain'

Camera analog gain value.

fpipy.conventions.cfa_data = 'dn'

DataArray containing a stack of raw CFA images.

fpipy.conventions.cfa_dims = ('index', 'y', 'x')

Convention for CFA image stacks.

fpipy.conventions.cfa_pattern_data = 'bayer_pattern'

String denoting the pattern (e.g. RGGB) of the colour filter array.

fpipy.conventions.colour_coord = 'colour'

Colour coordinate for values indexed w.r.t. CFA colours.

fpipy.conventions.dark_corrected_cfa_data = 'dn_dark_corrected'

DataArray containing a stack of raw images with dark current corrected

fpipy.conventions.dark_ref_dims = ('y', 'x')

Convention for dark reference image dimensions.

fpipy.conventions.dark_reference_data = 'dark'

DataArray containing a dark current reference.

fpipy.conventions.fwhm_data = 'fwhm'

Full Width at Half Maximum values

fpipy.conventions.genicam_exposure = 'ExposureTime'

Camera exposure time in microseconds as defined by GenICam.

fpipy.conventions.genicam_pattern_data = 'PixelColorFilter'

String denoting the pattern (e.g. BayerGB) of the colour filter array.

fpipy.conventions.image_index = 'index'

Index number of the image in a given stack.

fpipy.conventions.number_of_peaks = 'npeaks'

Number of passband peaks included in a given image.

fpipy.conventions.peak_coord = 'peak'

Index coordinate denoting passband peaks of the FPI.

fpipy.conventions.radiance_data = 'radiance'

DataArray containing a stack of radiance images.

fpipy.conventions.radiance_dims = ('band', 'y', 'x')

Convention for radiance image stacks.

fpipy.conventions.reflectance_data = 'reflectance'

DataArray containing a stack of reflectance images.

fpipy.conventions.rgb_data = 'rgb'

DataArray containing a stack of RGB images.

fpipy.conventions.setpoint_coord = 'setpoint_index'

Coordinate denoting the the setpoint (which voltage it denotes)

fpipy.conventions.setpoint_data = 'setpoint'

Values of the setpoints.

fpipy.conventions.sinv_data = 'sinvs'

Inversion coefficients for radiance calculation.

fpipy.conventions.sinv_dims = ('index', 'peak', 'colour')

Convention for inversion coefficient dimensions.

fpipy.conventions.wavelength_data = 'wavelength'

Passband center wavelength values.