ReadOutParameters (LSST CCS - Image Utilities 2.0.8 API)

java.lang.Object
- org.lsst.ccs.utilities.image.ReadOutParameters

```
public final class ReadOutParameters
extends Object
```
An object that defines the read out parameters used to acquire an ImageSet. These are the parameters that are set on the Sequencer at the time of the acquisition. It also needs the CCDType to evaluate other quantities to be used when writing out fits files. These parameters are at the Segment level.

Author:

The LSST CCS Team

Constructor Summary

Constructors
Constructor and Description
`ReadOutParameters(CCDType type)` Create a full frame ReadOutParameters object for a given type of CCD
`ReadOutParameters(CCDType ccdType, int preRows, int readRows, int postRows, int overRows, int preCols, int readCols, int postCols, int readCols2, int overCols)` Segment redout parameters quantities according to https://jira.slac.stanford.edu/projects/LSSTCCSRAFTS/issues/LSSTCCSRAFTS-67.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`getCCDTotalParallelSize(CCD ccd, ReadOutParameters readOutParameters)` Utility method to get a CCD full parallel size for a given ReadOutParameter.
`static int`	`getCCDTotalSerialSize(CCD ccd, ReadOutParameters readOutParameters)` Utility method to get a CCD full serial size for a given ReadOutParameter.
`int`	`getOverCols()` Get the number of the read columns in over scan.
`int`	`getOverRows()` Get the number of the read columns for the second sub-array.
`int`	`getParallelReadPixels()` Utility method to get the the number of pixels read in the parallel direction.
`int`	`getPostCols()` Get the number of the discarded columns after the ones that have been read.
`int`	`getPostRows()` Get the number of the discarded rows after the ones that have been read.
`int`	`getPreCols()` Get the number of the skipped columns.
`int`	`getPreRows()` Get the number of the skipped rows.
`int`	`getReadCols()` Get the number of the read columns.
`int`	`getReadCols2()` Get the number of the read columns.
`int`	`getReadRows()` Get the number of the read rows.
`int`	`getSerialPrescan()` Get the serial prescan size.
`int`	`getSerialReadPixels()` Utility method to get the the number of pixels read in the serial direction.
`int`	`getSerialRegister()` Utility method to get the serial register size.
`int`	`getTotalParallelSize()` Get the total parallel size in pixels.
`int`	`getTotalSerialSize()` Get the total serial size in pixels.
`void`	`setCCDType(CCDType ccdType)` Set the CCDType for this ReadOutParameter object.
`void`	`setOverCols(int overCols)` Set the number of the read columns in over scan.
`void`	`setOverRows(int overRows)` Set the number of the read rows in over scan.
`void`	`setPostCols(int postCols)` Set the number of the discarded columns after the ones that have been read.
`void`	`setPostRows(int postRows)` Set the number of the discarded rows after the ones that have been read.
`void`	`setPreCols(int preCols)` Set the number of the skipped columns.
`void`	`setPreRows(int preRows)` Set the number of the skipped rows.
`void`	`setReadCols(int readCols)` Set the number of the read columns.
`void`	`setReadCols2(int readCols2)` Set the number of the read columns for the second sub-array.
`void`	`setReadRows(int readRows)` Set the number of the read rows.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ReadOutParameters
```
public ReadOutParameters(CCDType ccdType,
                         int preRows,
                         int readRows,
                         int postRows,
                         int overRows,
                         int preCols,
                         int readCols,
                         int postCols,
                         int readCols2,
                         int overCols)
```
    Segment redout parameters quantities according to https://jira.slac.stanford.edu/projects/LSSTCCSRAFTS/issues/LSSTCCSRAFTS-67. The following parameters describe how each segment was read. TO-DO Add reference to diagram from confluence. TO-DO Add validate method to make sure the parameters meet the constraints listed at: https://confluence.slac.stanford.edu/x/hrjdD They are used both for full frame readout (the whole segment is read) and for ROI. readCols2 is used when an ROI is across segments.
    
    Parameters:
    
    preRows - Rows skipped
    
    readRows - Rows read
    
    postRows - Rows discarded after the read rows
    
    overRows - Rows read in over scan
    
    preCols - Columns skipped (this includes the pre scan columns)
    
    readCols - Columns read
    
    postCols - Columns discarded after the read columns
    
    readCols2 - Columns read for the second sub-array
    
    overCols - Columns read in over scan
    
    ccdType - The CCD Type
  - ReadOutParameters
```
public ReadOutParameters(CCDType type)
```
    Create a full frame ReadOutParameters object for a given type of CCD
    
    Parameters:
    
    type - The CCD type.
- Method Detail
  - getPreRows
```
public int getPreRows()
```
    Get the number of the skipped rows.
    
    Returns:
    
    The number of skipped rows.
  - setPreRows
```
public void setPreRows(int preRows)
```
    Set the number of the skipped rows.
    
    Parameters:
    
    preRows - The number of skipped rows.
  - getReadRows
```
public int getReadRows()
```
    Get the number of the read rows.
    
    Returns:
    
    The number of read rows.
  - setReadRows
```
public void setReadRows(int readRows)
```
    Set the number of the read rows.
    
    Parameters:
    
    readRows - The number of read rows.
  - getPostRows
```
public int getPostRows()
```
    Get the number of the discarded rows after the ones that have been read.
    
    Returns:
    
    The number of discarded rows after the ones that have been read.
  - setPostRows
```
public void setPostRows(int postRows)
```
    Set the number of the discarded rows after the ones that have been read.
    
    Parameters:
    
    postRows - The number of discarded rows after the ones that have been read.
  - getPreCols
```
public int getPreCols()
```
    Get the number of the skipped columns.
    
    Returns:
    
    The number of skipped columns.
  - setPreCols
```
public void setPreCols(int preCols)
```
    Set the number of the skipped columns.
    
    Parameters:
    
    preCols - The number of skipped columns.
  - getReadCols
```
public int getReadCols()
```
    Get the number of the read columns.
    
    Returns:
    
    The number of read columns.
  - setReadCols
```
public void setReadCols(int readCols)
```
    Set the number of the read columns.
    
    Parameters:
    
    readCols - The number of read columns.
  - getPostCols
```
public int getPostCols()
```
    Get the number of the discarded columns after the ones that have been read.
    
    Returns:
    
    The number of discarded columns after the ones that have been read.
  - setPostCols
```
public void setPostCols(int postCols)
```
    Set the number of the discarded columns after the ones that have been read.
    
    Parameters:
    
    postCols - The number of discarded columns after the ones that have been read.
  - getReadCols2
```
public int getReadCols2()
```
    Get the number of the read columns.
    
    Returns:
    
    The number of read columns.
  - setReadCols2
```
public void setReadCols2(int readCols2)
```
    Set the number of the read columns for the second sub-array.
    
    Parameters:
    
    readCols2 - The number of the read columns for the second sub-array.
  - getOverRows
```
public int getOverRows()
```
    Get the number of the read columns for the second sub-array. This is the parallel over scan size.
    
    Returns:
    
    The number of the read columns for the second sub-array.
  - setOverRows
```
public void setOverRows(int overRows)
```
    Set the number of the read rows in over scan.
    
    Parameters:
    
    overRows - The number of read rows in over scan.
  - getOverCols
```
public int getOverCols()
```
    Get the number of the read columns in over scan. These is the serial over scan size.
    
    Returns:
    
    The number of read columns in over scan.
  - setOverCols
```
public void setOverCols(int overCols)
```
    Set the number of the read columns in over scan.
    
    Parameters:
    
    overCols - The number of read columns in over scan.
  - getSerialReadPixels
```
public int getSerialReadPixels()
```
    Utility method to get the the number of pixels read in the serial direction. This is the sum of the read and over scan pixels. Notice that readCols includes pre scan pixels in full frame mode.
    
    Returns:
    
    the number of pixels read in the serial direction.
  - getParallelReadPixels
```
public int getParallelReadPixels()
```
    Utility method to get the the number of pixels read in the parallel direction. This is the sum of the read and over scan pixels.
    
    Returns:
    
    the number of pixels read in the parallel direction.
  - getSerialRegister
```
public int getSerialRegister()
```
    Utility method to get the serial register size. It's the sum of preCols, readCols, postCols and readCols2.
    
    Returns:
    
    the serialRegister size
  - getSerialPrescan
```
public int getSerialPrescan()
```
    Get the serial prescan size. This corresponds to Designator variable "preh" in Table 8 of LCA-13501 The difference between the serial prescan size and the preCols quantity is that the serial prescan is read in prescan mode, while the preCols are skipped.
    
    Returns:
    
    The serial prescan size.
  - getTotalSerialSize
```
public int getTotalSerialSize()
```
    Get the total serial size in pixels. This is the sum of the serial pre scan, active and over scan sizes.
    
    Returns:
    
    The total serial size in pixels.
  - getTotalParallelSize
```
public int getTotalParallelSize()
```
    Get the total parallel size in pixels. This is the sum of the parallel over scan and the active sizes.
    
    Returns:
    
    The total serial size in pixels.
  - getCCDTotalSerialSize
```
public static int getCCDTotalSerialSize(CCD ccd,
                                        ReadOutParameters readOutParameters)
```
    Utility method to get a CCD full serial size for a given ReadOutParameter. The full serial size of a CCD is the product of a segment total serial size and the number of segments in the serial direction. This size includes active, pre and post scan sizes.
    
    Parameters:
    
    ccd - The CCD instance.
    
    readOutParameters - The ReadOutParameters.
    
    Returns:
    
    The CCD full serial size including pre and over scans.
  - getCCDTotalParallelSize
```
public static int getCCDTotalParallelSize(CCD ccd,
                                          ReadOutParameters readOutParameters)
```
    Utility method to get a CCD full parallel size for a given ReadOutParameter. The full parallel size of a CCD is the product of a segment total parallel size and the number of segments in the parallel direction. This size includes active and over scan sizes.
    
    Parameters:
    
    ccd - The CCD instance.
    
    readOutParameters - The ReadOutParameters.
    
    Returns:
    
    The CCD full parallel size including over scan.
  - setCCDType
```
public void setCCDType(CCDType ccdType)
```
    Set the CCDType for this ReadOutParameter object.
    
    Parameters:
    
    ccdType - The CCD type.

Class ReadOutParameters

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReadOutParameters

ReadOutParameters

Method Detail

getPreRows

setPreRows

getReadRows

setReadRows

getPostRows

setPostRows

getPreCols

setPreCols

getReadCols

setReadCols

getPostCols

setPostCols

getReadCols2

setReadCols2

getOverRows

setOverRows

getOverCols

setOverCols

getSerialReadPixels

getParallelReadPixels

getSerialRegister

getSerialPrescan

getTotalSerialSize

getTotalParallelSize

getCCDTotalSerialSize

getCCDTotalParallelSize

setCCDType