Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added new classes from pdsdata V02-04-00

...

Panel

Anchor
_pdsdata.encoder.DataV1
_pdsdata.encoder.DataV1

Class _pdsdata.encoder.DataV1

Python wrapper for pdsdata/encoder/DataV1 class.


Construction

This class cannot be instantiated directly, methods of other classes return instances of this type.


Property _33mhz_timestamp

Usage: val = data._33mhz_timestamp

Returns integer value.


Property _encoder_count

Usage: val = data._encoder_count

Returns integer value.


Method value()

Usage: val = data.value()

Returns integer value.

...

Anchor
_pdsdata.epics
_pdsdata.epics

...

Panel

Anchor
_pdsdata.fccd.FccdConfigV1
_pdsdata.fccd.FccdConfigV1

Class _pdsdata.fccd.FccdConfigV1

Python wrapper for pdsdata/fccd/FccdConfigV1 class.


Enum Depth

This enum is an embedded type of FccdConfigV1 class. Following enum members are defined currently:

  • ConfigV1.Depth.Sixteen_bit

Enum Output_Source

This enum is an embedded type of FccdConfigV1 class. Following enum members are defined currently:

  • ConfigV1.Output_Source.Output_FIFO
  • ConfigV1.Output_Source.Output_Pattern4

Construction

This class cannot be instantiated directly, methods of other classes return instances of this type.


Method width()

Usage: val = config.width()

Returns integer number.


Method height()

Usage: val = config.height()

Returns integer number.


Method trimmedWidth()

Usage: val = config.trimmedWidth()

Returns integer number.


Method trimmedHeight()

Usage: val = config.trimmedHeight()

Returns integer number.


Method outputMode()

Usage: val = config.outputMode()

Returns integer number.


Method size()

Usage: val = config.size()

Returns integer number.

...

.

...

Module _pdsdata.ipimb

This module contains classes corresponding to those in C++ pdsdata/ipimb package.

...

Panel

Anchor
_pdsdata.ipimbfccd.ConfigV1FccdConfigV2
_pdsdata.ipimbfccd.ConfigV1FccdConfigV2

Class _pdsdata.

ipimb

fccd.

ConfigV1

FccdConfigV2

Python wrapper for pdsdata/ipimbfccd/ConfigV1 FccdConfigV2 class.

Construction

Enum Depth

This class cannot be instantiated directly, methods of other classes return instances of this type.

Method triggerCounter()

Usage: val = config.triggerCounter()

Returns integer number.

Method serialID()

Usage: val = config.serialID()

Returns integer number.

Method chargeAmpRange

enum is an embedded type of FccdConfigV2 class. Following enum members are defined currently:

  • ConfigV2.Depth.Eight_bit
  • ConfigV2.Depth.Sixteen_bit

Enum Output_Source

This enum is an embedded type of FccdConfigV2 class. Following enum members are defined currently:

  • ConfigV2.Output_Source.Output_FIFO
  • ConfigV2.Output_Source.Test_Pattern1
  • ConfigV2.Output_Source.Test_Pattern2
  • ConfigV2.Output_Source.Test_Pattern3
  • ConfigV2.Output_Source.Test_Pattern4

Construction

This class cannot be instantiated directly, methods of other classes return instances of this type.


Method width()

Usage: val = config.chargeAmpRangewidth()

Returns integer number.


Method

calibrationRange

height()

Usage: val = config.calibrationRangeheight()

Returns integer number.


Method

resetLength

trimmedWidth()

Usage: val = config.resetLengthtrimmedWidth()

Returns integer number.


Method

resetDelay

trimmedHeight()

Usage: val = config.resetDelaytrimmedHeight()

Returns integer number.


Method

chargeAmpRefVoltage

outputMode()

Usage: val = config.chargeAmpRefVoltageoutputMode()

Returns floating integer number.


Method

calibrationVoltage

size()

Usage: val = config.calibrationVoltagesize()

Returns floating integer number.


Method

diodeBias

ccdEnable()

Usage: val = config.diodeBiasccdEnable()

Returns floating numberBoolean value.


Method

status

focusMode()

Usage: val = config.statusfocusMode()

Returns integer numberBoolean value.


Method

errors

exposureTime()

Usage: val = config.errorsexposureTime()

Returns integer number.

Method calStrobeLength

Methods dacVoltageXX()

Usage: val = config.calStrobeLengthdacVoltage1() to val = config.dacVoltage17()

Returns integer floating number.

Method trigDelay

Methods waveformXX()

Usage: val = config.trigDelaywaveform0() to val = config.waveform14()

Returns integer number.

...

Anchor
_pdsdata.ipimb
_pdsdata.ipimb

Module _pdsdata.ipimb

This module contains classes corresponding to those in C++ pdsdata/ipimb package.

Panel

Anchor
_pdsdata.ipimb.DataV1ConfigV1
_pdsdata.ipimb.DataV1ConfigV1

Class _pdsdata.ipimb.

DataV1

ConfigV1

Python wrapper for pdsdata/ipimb/DataV1 ConfigV1 class.


Construction

This class cannot be instantiated directly, methods of other classes return instances of this type.


Method triggerCounter()

Usage: val = config.triggerCounter()

Returns integer number.


Method

config0

serialID()

Usage: val = config.config0serialID()

Returns integer number.


Method

config1

chargeAmpRange()

Usage: val = config.config1chargeAmpRange()

Returns integer number.


Method

config2

calibrationRange()

Usage: val = config.config2calibrationRange()

Returns integer number.


Method

channel0

resetLength()

Usage: val = config.channel0resetLength()

Returns integer number.


Method

channel1

resetDelay()

Usage: val = config.channel1resetDelay()

Returns integer number.


Method

channel2

chargeAmpRefVoltage()

Usage: val = config.channel2chargeAmpRefVoltage()

Returns integer floating number.


Method

channel3

calibrationVoltage()

Usage: val = config.channel3calibrationVoltage()

Returns integer floating number.


Method

channel0Volts

diodeBias()

Usage: val = config.channel0VoltsdiodeBias()

Returns floating number.


Method

channel1Volts

status()

Usage: val = config.channel1Voltsstatus()

Returns floating integer number.


Method

channel2Volts

errors()

Usage: val = config.channel2Voltserrors()

Returns floating integer number.


Method

channel3Volts

calStrobeLength()

Usage: val = config.channel3VoltscalStrobeLength()

Returns floating integer number.


Method

checksum

trigDelay()

Usage: val = config.checksumtrigDelay()

Returns integer number.

...

Panel

Anchor
_pdsdata.ipimb.

...

DataV1
_pdsdata.

...

ipimb.DataV1

...

Class _pdsdata.

...

ipimb.DataV1

Python wrapper for pdsdata/ipimb/DataV1 class.


Construction

This class cannot be instantiated directly, methods of other classes return instances of this type.


Method triggerCounter()

Usage: val = config.triggerCounter()

Returns integer number.


Method config0()

Usage: val = config.config0()

Returns integer number.


Method config1()

Usage: val = config.config1()

Returns integer number.


Method config2()

Usage: val = config.config2()

Returns integer number.


Method channel0()

Usage: val = config.channel0()

Returns integer number.


Method channel1()

Usage: val = config.channel1()

Returns integer number.


Method channel2()

Usage: val = config.channel2()

Returns integer number.


Method channel3()

Usage: val = config.channel3()

Returns integer number.


Method channel0Volts()

Usage: val = config.channel0Volts()

Returns floating number.


Method channel1Volts()

Usage: val = config.channel1Volts()

Returns floating number.


Method channel2Volts()

Usage: val = config.channel2Volts()

Returns floating number.


Method channel3Volts()

Usage: val = config.channel3Volts()

Returns floating number.


Method checksum()

Usage: val = config.checksum()

Returns integer number.

...

Anchor
_pdsdata.opal1k
_pdsdata.opal1k

Module _pdsdata.opal1k

This module contains classes corresponding to those in C++ pdsdata/opal1k package.

Panel

Anchor
_pdsdata.opal1k.ConfigV1
_pdsdata.opal1k.ConfigV1

Class _pdsdata.opal1k.ConfigV1

Python wrapper for pdsdata/opal1k/ConfigV1 class.


Constants

  • LUT_Size
  • Row_Pixels
  • Column_Pixels

Enum Depth

This enum is an embedded type of ConfigV1 class. Following enum members are defined currently:

  • ConfigV1.Depth.Eight_bit
  • ConfigV1.Depth.Ten_bit
  • ConfigV1.Depth.Twelve_bit

Enum Binning

This enum is an embedded type of ConfigV1 class. Following enum members are defined currently:

  • ConfigV1.Binning.x1
  • ConfigV1.Binning.x2
  • ConfigV1.Binning.x4
  • ConfigV1.Binning.x8

Enum Mirroring

This enum is an embedded type of ConfigV1 class. Following enum members are defined currently:

  • ConfigV1.Mirroring.None
  • ConfigV1.Mirroring.HFlip
  • ConfigV1.Mirroring.VFlip
  • ConfigV1.Mirroring.HVFlip

Construction

This class cannot be instantiated directly, methods of other classes return instances of this type.


Method black_level()

Usage: val = config.black_level()

Returns offset/pedestal setting for camera (before gain) as integer number.


Method gain_percent()

Usage: val = config.gain_percent()

Wiki Markup
Returns camera gain setting in percentile (\[100-3200\] = \[1x-32x\]) as integer number.


Method output_offset()

Usage: val = config.output_offset()

Returns offset/pedestal value in pixel counts as integer number.


Method output_resolution()

Usage: val = config.output_resolution()

Returns bit-depth of pixel counts as enum ConfigV1.Depth.


Method output_resolution_bits()

Usage: val = config.output_resolution_bits()

Returns bit-depth of pixel counts (in actual bits).


Method vertical_binning()

Usage: val = config.vertical_binning()

Returns vertical re-binning of output (consecutive rows summed) as enum ConfigV1.Binning.


Method output_mirroring()

Usage: val = config.output_mirroring()

Returns geometric transformation of the image as enum ConfigV1.Mirroring.


Method vertical_remapping()

Usage: val = config.vertical_remapping()

Returns Boolean, true: remap the pixels to appear in natural geometric order (left->right, top->bottom), false: pixels appear on dual taps from different rows (left->right, top->bottom) alternated with (left->right, bottom->top) pixel by pixel.


Method defect_pixel_correction_enabled()

Usage: val = config.defect_pixel_correction_enabled()

Returns Boolean value.


Method output_lookup_table_enabled()

Usage: val = config.output_lookup_table_enabled()

Returns Boolean value.


Method output_lookup_table()

Usage: val = config.output_lookup_table()

Returns output lookup table as NumPy array, elements of array are unsigned numbers.


Method number_of_defect_pixels()

Usage: val = config.number_of_defect_pixels()

Returns defective pixel count.


Method defect_pixel_coordinates()

Usage: val = config.defect_pixel_coordinates()

Returns list of defective pixel coordinates, elements of the list have type camera.FrameCoord.


Method size()

Usage: val = config.size()

Returns total size of this structure.

...

Anchor
_pdsdata.pnccd
_pdsdata.pnccd

Module _pdsdata.pnccd

This module This module contains classes corresponding to those in C++ pdsdata/opal1k pnCCD package.

Panel

Anchor
_pdsdata.opal1kpnccd.ConfigV1
_pdsdata.opal1kpnccd.ConfigV1

Class _pdsdata.

opal1k

pnccd.ConfigV1

Python wrapper for pdsdata/opal1kpnCCD/ConfigV1 class.

Constants

  • LUT_Size
  • Row_Pixels
  • Column_Pixels

Enum Depth

This enum is an embedded type of ConfigV1 class. Following enum members are defined currently:

  • ConfigV1.Depth.Eight_bit
  • ConfigV1.Depth.Ten_bit
  • ConfigV1.Depth.Twelve_bit

Enum Binning

This enum is an embedded type of ConfigV1 class. Following enum members are defined currently:

  • ConfigV1.Binning.x1
  • ConfigV1.Binning.x2
  • ConfigV1.Binning.x4
  • ConfigV1.Binning.x8

Enum Mirroring

This enum is an embedded type of ConfigV1 class. Following enum members are defined currently:

  • ConfigV1.Mirroring.None
  • ConfigV1.Mirroring.HFlip
  • ConfigV1.Mirroring.VFlip
  • ConfigV1.Mirroring.HVFlip

    Construction

    This class cannot be instantiated directly, methods of other classes return instances of this type.


    Method numLinks()

    Usage: val = config.numLinks()

    Returns number of links.


    Method payloadSizePerLink()

    Usage: val = config.payloadSizePerLink()

    Returns data size per link.

    ...

    Returns camera gain setting in percentile (\[100-3200\] = \[1x-32x\]) as integer number.


    Method

    output_offset

    numSubmodules()

    Usage: val = config.output_offsetnumSubmodules()

    Returns offset/pedestal value in pixel counts as integer number.


    Method

    output_resolution

    camexMagic()

    Usage: val = config.output_resolutioncamexMagic()

    Returns bit-depth of pixel counts as enum ConfigV1.Depth.

    Method output_resolution_bits

    integer number.


    Method info()

    Usage: val = config.output_resolution_bitsinfo()

    Returns bit-depth of pixel counts (in actual bits)string.


    Method

    vertical_binning

    timingFName()

    Usage: val = config.vertical_binningtimingFName()

    Returns vertical re-binning of output (consecutive rows summed) as enum ConfigV1.Binningstring.


    Method

    output_mirroring

    size()

    Usage: val = config.output_mirroringsize()

    Returns geometric transformation of the image as enum ConfigV1.Mirroring.

    Method vertical_remapping

    size of the object.

    Panel

    Anchor
    _pdsdata.pnccd.ConfigV2
    _pdsdata.pnccd.ConfigV2

    Class _pdsdata.pnccd.ConfigV2

    Python wrapper for pdsdata/pnCCD/ConfigV2 class.


    Construction

    This class cannot be instantiated directly, methods of other classes return instances of this type.

    Method black_level

    .


    Method numLinks()

    Usage: val = config.numLinks()

    Returns number of links.


    Method payloadSizePerLink()

    Usage: val = config.payloadSizePerLink()

    Returns data size per link.


    Method numChannels()

    Usage: val = config.numChannels()

    Returns number of channels.


    Method numRows()

    Usage: val = config.numRows()

    Returns number of rows.


    Method numSubmoduleChannels()

    Usage: val = config.black_levelnumSubmoduleChannels()

    Returns offset/pedestal setting for camera (before gain) as integer number.


    Method

    gain_percent

    numSubmoduleRows()

    Usage: val = config.gain_percentnumSubmoduleRows()

    Wiki Markup

    ...

    Panel

    Anchor
    _pdsdata.pnccd.FrameV1
    _pdsdata.pnccd.FrameV1

    Class _pdsdata.pnccd.FrameV1

    Python wrapper for pdsdata/pnCCD/FrameV1 class.


    Construction

    This class cannot be instantiated directly, methods of other classes return instances of this type.


    Method specialWord()

    Usage: val = configframe.vertical_remappingspecialWord()

    Returns Boolean, true: remap the pixels to appear in natural geometric order (left->right, top->bottom), false: pixels appear on dual taps from different rows (left->right, top->bottom) alternated with (left->right, bottom->top) pixel by pixel.

    Method defect_pixel_correction_enabled

    integer number.


    Method frameNumber()

    Usage: val = config.defect_pixel_correction_enabledframe.frameNumber()

    Returns Boolean valueinteger number.


    Method

    output_lookup_table_enabled

    timeStampHi()

    Usage: val = config.output_lookup_table_enabledframe.timeStampHi()

    Returns Boolean valueinteger number.


    Method

    output_lookup_table

    timeStampLo()

    Usage: val = config.output_lookup_tableframe.timeStampLo()

    Returns output lookup table as NumPy array, elements of array are unsigned numbersinteger number.


    Method

    number_of_defect_pixels

    next()

    Usage: val = config.number_of_defect_pixels()

    Returns defective pixel count.

    Method defect_pixel_coordinates

    frame.next(config)

    Returns next frame object or None.

    Arguments:


    Method data()

    Usage: val = config.defect_pixel_coordinates(frame.data(config)

    Returns list of defective pixel coordinates, elements of the list have type camera.FrameCoord.

    Method size

    frame data as NumPy 2-dimensional array of integers of size 512x512.

    Arguments:


    Method sizeofData()

    Usage: val = configframe.sizesizeofData(config)

    Returns total size of this structureinteger number.

    Arguments:

    ...

    Anchor
    _pdsdata.pnccdprinceton
    _pdsdata.pnccdprinceton

    Module _pdsdata.

    ...

    princeton

    This module contains classes corresponding to those in C++ pdsdata/pnCCD princeton package.

    Class _pdsdata.pnccd.ConfigV2

    Python wrapper for pdsdata/pnCCD/ConfigV2 class.

    Construction

    This class cannot be instantiated directly, methods of other classes return instances of this type.

    Method numLinks

    ()

    Usage: val = config.numLinksorgX()

    Returns integer number of links.


    Method

    payloadSizePerLink

    orgY()

    Usage: val = config.payloadSizePerLinkorgY()

    Returns data size per linkinteger number.


    Method

    numChannels

    binX()

    Usage: val = config.numChannelsbinX()

    Returns integer number of channels.


    Method

    numRows

    binY()

    Usage: val = config.numRowsbinY()

    Returns integer number of rows.


    Method

    numSubmoduleChannels

    exposureTime()

    Usage: val = config.numSubmoduleChannelsexposureTime()

    Returns integer floating number.


    Method

    numSubmoduleRows

    coolingTemp()

    Usage: val = config.numSubmoduleRowscoolingTemp()

    Returns integer floating number.


    Method

    numSubmodules

    readoutSpeedIndex()

    Usage: val = config.numSubmodulesreadoutSpeedIndex()

    Returns integer number.


    Method

    camexMagic

    readoutEventCode()

    Usage: val = config.camexMagicreadoutEventCode()

    Returns integer number.


    Method

    info

    delayMode()

    Usage: val = config.infodelayMode()

    Returns stringinteger number.


    Method

    timingFName

    size()

    Usage: val = config.timingFNamesize()

    Returns stringinteger number.


    Method

    size

    frameSize()

    Usage: val = config.sizeframeSize()

    Returns calculated frame size of the objectbased on the current ROI and binning settings.

    Panel

    Anchor
    _pdsdata.pnccdprinceton.ConfigV1
    _pdsdata.pnccdprinceton.ConfigV1

    Class _pdsdata.

    pnccd

    princeton.ConfigV1

    Python wrapper for pdsdata/pnCCDprinceton/ConfigV1 class.


    Construction

    This class cannot be instantiated directly, methods of other classes return instances of this type.


    Method

    numLinks

    width()

    Usage: val = config.numLinkswidth()

    Returns integer number of links.


    Method

    payloadSizePerLink

    height()

    Usage: val = config.payloadSizePerLinkheight()

    Returns data size per link.

    Panel

    integer number.


    Method orgX

    Anchor
    _pdsdata.pnccd.ConfigV2_pdsdata.pnccd.ConfigV2

    ...

    Panel

    Anchor
    _pdsdata.pnccdprinceton.FrameV1
    _pdsdata.pnccdprinceton.FrameV1

    Class _pdsdata

    .pnccd.FrameV1

    Python wrapper for pdsdata/pnCCD/FrameV1 class.

    Construction

    This class cannot be instantiated directly, methods of other classes return instances of this type.

    Method specialWord()

    Usage: val = frame.specialWord()

    Returns integer number.

    Method frameNumber()

    Usage: val = frame.frameNumber()

    Returns integer number.

    Method timeStampHi()

    Usage: val = frame.timeStampHi()

    Returns integer number.

    Method timeStampLo

    .princeton.FrameV1

    Python wrapper for pdsdata/princeton/FrameV1 class.


    Construction

    This class cannot be instantiated directly, methods of other classes return instances of this type.


    Method shotIdStart()

    Usage: val = frameconfig.timeStampLoshotIdStart()

    Returns integer number.


    Method

    next

    readoutTime()

    Usage: val = frameconfig.nextreadoutTime(config)

    Returns next frame object or None.

    Arguments:

    config - object of type pnccd.ConfigV1 or pnccd.ConfigV2.

    floating number.


    Method data()

    Usage: val = frameconfig.data(config)

    Returns frame data as NumPy 2-dimensional array of integers of size 512x512.

    Arguments:

    Method sizeofData()

    Usage: val = frame.sizeofData(config)

    Returns integer number.

    , size is determined by the configuration object.

    Arguments:

    ...

    Anchor
    _pdsdata.princetonpulnix
    _pdsdata.princetonpulnix

    Module _pdsdata.

    ...

    pulnix

    This module contains classes corresponding to those in C++ pdsdata/princeton pulnix package.

    Class _pdsdata.princeton.FrameV1

    Python wrapper for pdsdata/princeton/FrameV1 class.

    Construction

    This class cannot be instantiated directly, methods of other classes return instances of this type.

    Method shotIdStart

    ()

    Usage: val = config.shotIdStartvertical_binning()

    Returns integer number.

    Method readoutTime()

    Usage: val = config.readoutTime()

    Returns floating number.

    Method data

    vertical re-binning of output (consecutive rows summed) as enum TM6740ConfigV1.Binning.


    Method lookuptable_mode()

    Usage: val = config.datalookuptable_mode(config)

    Returns frame data as NumPy 2-dimensional array of integers, size is determined by the configuration object.

    Arguments:

    Panel

    Anchor
    _pdsdata.princetonpulnix.ConfigV1TM6740ConfigV1
    _pdsdata.princetonpulnix.ConfigV1TM6740ConfigV1

    Class _pdsdata.

    princeton

    pulnix.

    ConfigV1

    TM6740ConfigV1

    Python wrapper for pdsdata/princetonpulnix/ConfigV1 TM6740ConfigV1 class.

    Construction

    This class cannot be instantiated directly, methods of other classes return instances of this type.

    Method width()

    Usage: val = config.width()

    Returns integer number.

    Method height()

    Usage: val = config.height()

    Returns integer number.

    Method orgX()

    Usage: val = config.orgX()

    Returns integer number.

    Method orgY()

    Usage: val = config.orgY()

    Returns integer number.

    Method binX()

    Usage: val = config.binX()

    Returns integer number.

    Method binY


    Constants

    • Row_Pixels
    • Column_Pixels

    Enum Depth

    This enum is an embedded type of TM6740ConfigV1 class. Following enum members are defined currently:

    • TM6740ConfigV1.Depth.Eight_bit
    • TM6740ConfigV1.Depth.Ten_bit

    Enum Binning

    This enum is an embedded type of TM6740ConfigV1 class. Following enum members are defined currently:

    • TM6740ConfigV1.Binning.x1
    • TM6740ConfigV1.Binning.x2
    • TM6740ConfigV1.Binning.x4

    Enum LookupTable

    This enum is an embedded type of TM6740ConfigV1 class. Following enum members are defined currently:

    • TM6740ConfigV1.LookupTable.Gamma
    • TM6740ConfigV1.LookupTable.Linear

    Construction

    This class cannot be instantiated directly, methods of other classes return instances of this type.


    Method vref()

    Usage: val = config.binYvref()

    Returns integer number.


    Method

    exposureTime

    gain_a()

    Usage: val = config.exposureTimegain_a()

    Returns floating integer number.


    Method

    coolingTemp

    gain_b()

    Usage: val = config.coolingTempgain_b()

    Returns floating integer number.


    Method

    readoutSpeedIndex

    gain_balance()

    Usage: val = config.readoutSpeedIndexgain_balance()

    Returns integer numberBoolean value.


    Method

    readoutEventCode

    shutter_width()

    Usage: val = config.readoutEventCodeshutter_width()

    Returns integer number.


    Method

    delayMode

    output_resolution()

    Usage: val = config.delayModeoutput_resolution()

    Returns integer numberbit-depth of pixel counts as enum TM6740ConfigV1.Depth.


    Method

    size

    output_resolution_bits()

    Usage: val = config.sizeoutput_resolution_bits()

    Returns integer numberbit-depth of pixel counts (in actual bits).


    Method

    frameSize

    horizontal_binning()

    Usage: val = config.frameSizehorizontal_binning()

    Returns calculated frame size based on the current ROI and binning settings.

    Panel

    horizontal re-binning of output (consecutive columns summed) as enum TM6740ConfigV1.Binning.


    Method vertical_binning

    Anchor
    _pdsdata.princeton.FrameV1_pdsdata.princeton.FrameV1

    ...

    Module _pdsdata.pulnix

    ...

    output lookup table corrections as enum TM6740ConfigV1.LookupTable.

    ...

    Panel

    Anchor
    _pdsdata.pulnix.TM6740ConfigV1TM6740ConfigV2
    _pdsdata.pulnix.TM6740ConfigV1TM6740ConfigV2

    Class _pdsdata.pulnix.

    TM6740ConfigV1

    TM6740ConfigV2

    Python wrapper for pdsdata/pulnix/TM6740ConfigV1 TM6740ConfigV2 class.


    Constants

    • Row_Pixels
    • Column_Pixels

    Enum Depth

    This enum is an embedded type of TM6740ConfigV1 TM6740ConfigV2 class. Following enum members are defined currently:

    • TM6740ConfigV1TM6740ConfigV2.Depth.Eight_bit
    • TM6740ConfigV1TM6740ConfigV2.Depth.Ten_bit

    Enum Binning

    This enum is an embedded type of TM6740ConfigV1 TM6740ConfigV2 class. Following enum members are defined currently:

    • TM6740ConfigV1TM6740ConfigV2.Binning.x1
    • TM6740ConfigV1TM6740ConfigV2.Binning.x2
    • TM6740ConfigV1TM6740ConfigV2.Binning.x4

    Enum LookupTable

    This enum is an embedded type of TM6740ConfigV1 TM6740ConfigV2 class. Following enum members are defined currently:

    • TM6740ConfigV1TM6740ConfigV2.LookupTable.Gamma
    • TM6740ConfigV1TM6740ConfigV2.LookupTable.Linear

    Construction

    This class cannot be instantiated directly, methods of other classes return instances of this type.


    Method vref_a()

    Usage: val = config.vref_a()

    Returns integer number.


    Method

    gain

    vref_

    a

    b()

    Usage: val = config.gainvref_ab()

    Returns integer number.


    Method gain_

    b

    a()

    Usage: val = config.gain_ba()

    Returns integer number.


    Method gain_

    balance

    b()

    Usage: val = config.gain_balanceb()

    Returns Boolean valueinteger number.


    Method

    shutter

    gain_

    width

    balance()

    Usage: val = config.shuttergain_widthbalance()

    Returns integer numberBoolean value.


    Method output_resolution()

    Usage: val = config.output_resolution()

    Returns bit-depth of pixel counts as enum TM6740ConfigV1.Depth.


    Method output_resolution_bits()

    Usage: val = config.output_resolution_bits()

    Returns bit-depth of pixel counts (in actual bits).


    Method horizontal_binning()

    Usage: val = config.horizontal_binning()

    Returns horizontal re-binning of output (consecutive columns summed) as enum TM6740ConfigV1.Binning.


    Method vertical_binning()

    Usage: val = config.vertical_binning()

    Returns vertical re-binning of output (consecutive rows summed) as enum TM6740ConfigV1.Binning.


    Method lookuptable_mode()

    Usage: val = config.lookuptable_mode()

    Returns output lookup table corrections as enum TM6740ConfigV1.LookupTable.

    ...

    Panel

    Anchor
    pypdsdata.acqiris.DataDescV1
    pypdsdata.acqiris.DataDescV1

    Class pypdsdata.acqiris.DataDescV1

    This class overrides several methods in the corresponding _pdsdata.acqiris.DataDescV1 class to simplify user API.


    Construction

    Usage: dd = DataDescV1(orig, hcfg, vcfg)

    Arguments:


    Method nbrSamplesInSeg()

    Usage: nsampl = dd.nbrSamplesInSeg()

    Returns integer number.


    Method nbrSegments()

    Usage: nseg = dd.nbrSegments()

    Returns integer number.


    Method timestamp()

    Usage: ts = dd.timestamp(segment)

    Returns object of acqiris.TimestampV1 type.

    Arguments:

    • segment - segment number

    Method waveform()

    Usage: wf = dd.waveform()

    Returns waveform array of numpy.ndarray type.


    Method timestamps()

    Usage: ts = dd.timestamps()

    Returns NumPy array of timestamps (floating numbers). First element of array is always 0, other elements are equidistant with the distance and number of intervals determined by acqiris.HorizV1 object.

    ...

    Panel

    Anchor
    pypdsdata.pnccd.FrameV1
    pypdsdata.pnccd.FrameV1

    Class pypdsdata.pnccd.FrameV1

    This class overrides several methods in the corresponding _pdsdata.pnccd.FrameV1 class to simplify user API. In particular it merges four images from PnCCD into one larger image.


    Construction

    Usage: frame = FrameV1(frames, config)

    Arguments:


    Method specialWord()

    Usage: val = frame.specialWord()

    Returns integer number.


    Method frameNumber()

    Usage: val = frame.frameNumber()

    Returns integer number.


    Method timeStampHi()

    Usage: val = frame.timeStampHi()

    Returns integer number.


    Method timeStampLo()

    Usage: val = frame.timeStampLo()

    Returns integer number.


    Method data()

    Usage: val = frame.data()

    Returns frame data as NumPy 2-dimensional array of integers of size 1024x1024.


    Method sizeofData()

    Usage: val = frame.sizeofData()

    Returns integer number.

    ...

    Panel

    Anchor
    pypdsdata.princeton.FrameV1
    pypdsdata.princeton.FrameV1

    Class pypdsdata.princeton.FrameV1

    This class overrides several methods in the corresponding _pdsdata.princeton.FrameV1 class to simplify user API.


    Construction

    Usage: frame = FrameV1(frames, config)

    Arguments:


    Method shotIdStart()

    Usage: val = frame.shotIdStart()

    Returns integer number.


    Method readoutTime()

    Usage: val = frame.readoutTime()

    Returns floating number.


    Method data()

    Usage: val = frame.data()

    Returns frame data as NumPy 2-dimensional array of integers.