org.lsst.ccs.subsystem.rafts

Class ImageProc

java.lang.Object

org.lsst.ccs.subsystem.rafts.ImageProc

public class ImageProc
extends Object

Routines for handling image data

Author:

Owen Saxton

Constructor Summary

Constructors

Constructor and Description
ImageProc(org.lsst.ccs.drivers.reb.ImageClient imc) Constructor.

Method Summary

Modifier and Type	Method and Description
void	configure(REBDevice reb, org.lsst.ccs.Subsystem subsys, Logger log) Performs configuration.
void	configure(String rebName, int rebId, org.lsst.ccs.Subsystem subsys, Logger log) Deprecated.
void	enableScan(boolean enable) Enables/disables scan mode.
ImageData	getImage(int ccd, int offset, int count) Gets a portion of the current image.
org.lsst.ccs.drivers.reb.ImageMetadata	getImageMetadata() Gets the DAQ metadata for the current image.
double[][]	getImageStats() Gets pixel value statistics for the current image.
void	initImageWait() Initializes for a new set of images
List<String>	saveFitsImage(String dName)
List<String>	saveFitsImage(String dName, org.lsst.ccs.utilities.image.FitsHeaderMetadataProvider provider) Saves the current image data as one or more FITS files.
String	saveImage(String dName) Saves the current image as raw bytes.
void	setCcdMask(int ccdMask) Sets the mask of CCDs being used.
protected void	setConstFitsMetadata(long serial) Sets constant FITS metadata.
void	setDataInversion(boolean invert) Sets whether image data values are inverted
void	setDefaultImageDirectory(String dirName) Sets the default image directory.
void	setExposureTime(double expTime)
void	setFitsConditions(String filter, double temperature, double wavelength) Sets the FITS file test conditions.
void	setFitsFileName(String fitsFileName)
void	setFitsFileNamePatter(String fitsFileNamePattern) Deprecated.
void	setFitsFileNamePattern(String pattern) Sets the FITS image file name pattern.
void	setImageDataFileNamePatter(String imageDataFileNamePattern) Deprecated.
void	setImageDataFileNamePattern(String pattern) Sets the raw image data file name pattern.
void	setNumRebCcds(int numRebCcds) Sets the number of CCDs on the REB.
void	setRebGeometry(org.lsst.ccs.utilities.ccd.Reb reb) Set the Reb Geometry corresponding to this ImageProc instance.
protected void	setSequencerFileName(String name)
ByteBuffer[][]	splitImage() Splits the current image into its segments.
int	waitForImage(int timeout) Waits for an image to arrive

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageProc

public ImageProc(org.lsst.ccs.drivers.reb.ImageClient imc)

Constructor.

Parameters:

imc - The image client object

Method Detail

configure

public void configure(REBDevice reb,
                      org.lsst.ccs.Subsystem subsys,
                      Logger log)

Performs configuration.

Parameters:

reb - The REB device

subsys - The associated subsystem

log - The associated logger

configure

@Deprecated
public void configure(String rebName,
                                  int rebId,
                                  org.lsst.ccs.Subsystem subsys,
                                  Logger log)

Deprecated.

Performs configuration.

Parameters:

rebName - The REB device name

rebId - The REB ID (address)

subsys - The associated subsystem

log - The associated logger

enableScan

public void enableScan(boolean enable)

Enables/disables scan mode.

Parameters:

enable - True to enable, false to disable

setCcdMask

public void setCcdMask(int ccdMask)

Sets the mask of CCDs being used.

Parameters:

ccdMask - The mask of active CCDs

setNumRebCcds

public void setNumRebCcds(int numRebCcds)

Sets the number of CCDs on the REB.

Parameters:

numRebCcds - The number of CCDs

setRebGeometry

public void setRebGeometry(org.lsst.ccs.utilities.ccd.Reb reb)

Set the Reb Geometry corresponding to this ImageProc instance.

Parameters:

reb - The Reb Geometry.

setDataInversion

public void setDataInversion(boolean invert)

Sets whether image data values are inverted

Parameters:

invert - Whether data values are to be inverted

initImageWait

public void initImageWait()

Initializes for a new set of images

waitForImage

public int waitForImage(int timeout)

Waits for an image to arrive

Parameters:

timeout - The timeout (msec)

Returns:

The number of images received: 0 (if timed out) or 1

saveImage

public String saveImage(String dName)
                 throws RaftException,
                        IOException

Saves the current image as raw bytes. The name of the file is "Image_[reb]_[tstamp].dat", where [tstamp] is the 16-digit hexadecimal representation of the image timestamp, and [reb] is the name of the REB that produced the image.

Parameters:

dName - The name of the directory where the image file is to saved.

Returns:

The name of the saved file

Throws:

RaftException

IOException

saveFitsImage

public List<String> saveFitsImage(String dName,
                                  org.lsst.ccs.utilities.image.FitsHeaderMetadataProvider provider)
                           throws IOException,
                                  RaftException

Saves the current image data as one or more FITS files. Each active CCD on the REB produces a separate file. The name of each file is "Image_[reb]_[ccd]_[tstamp].fits", where [tstamp] is the 16-digit hexadecimal representation of the image timestamp, [reb] is the name of the REB, and [ccd] is the CCD number.

Parameters:

dName - The name of the directory where the FITS file is to be saved.

provider - An external FitsHeaderMetadataProvider.

Returns:

A list containing the names of the saved files

Throws:

RaftException

IOException

saveFitsImage

public List<String> saveFitsImage(String dName)
                           throws IOException,
                                  RaftException

Throws:

IOException

RaftException

getImageMetadata

public org.lsst.ccs.drivers.reb.ImageMetadata getImageMetadata()
                                                        throws RaftException

Gets the DAQ metadata for the current image.

Returns:

The image metadata

Throws:

RaftException

getImage

public ImageData getImage(int ccd,
                          int offset,
                          int count)
                   throws RaftException

Gets a portion of the current image.

Parameters:

ccd - The CCD number

offset - The offset (in pixels) to the first pixel data to obtain.

count - The number of data pixels to obtain. If zero, all the data, starting at offset, is obtained.

Returns:

The returned pixel data

Throws:

RaftException

getImageStats

public double[][] getImageStats()
                         throws RaftException

Gets pixel value statistics for the current image.

Returns:

The array of (average, stddev) pairs, one per image segment

Throws:

RaftException

splitImage

public ByteBuffer[][] splitImage()
                          throws RaftException

Splits the current image into its segments. Each active CCD on the REB produces 16 segments.

Returns:

The array of image segment buffers

Throws:

RaftException

setFitsConditions

public void setFitsConditions(String filter,
                              double temperature,
                              double wavelength)

Sets the FITS file test conditions.

Parameters:

filter - The filter name

temperature - The temperature set point

wavelength - The monochromator wavelength

setConstFitsMetadata

protected void setConstFitsMetadata(long serial)

Sets constant FITS metadata.

Parameters:

serial - The REB serial number

setSequencerFileName

protected void setSequencerFileName(String name)

setFitsFileName

public void setFitsFileName(String fitsFileName)

setExposureTime

public void setExposureTime(double expTime)

setDefaultImageDirectory

public void setDefaultImageDirectory(String dirName)

Sets the default image directory.

Parameters:

dirName - The directory name

setFitsFileNamePattern

public void setFitsFileNamePattern(String pattern)

Sets the FITS image file name pattern.

Parameters:

pattern - The file name pattern to set

setImageDataFileNamePattern

public void setImageDataFileNamePattern(String pattern)

Sets the raw image data file name pattern.

Parameters:

pattern - The file name pattern to set

setFitsFileNamePatter

@Deprecated
public void setFitsFileNamePatter(String fitsFileNamePattern)

Deprecated.

Setter method for the fits file name pattern.

Parameters:

fitsFileNamePattern - The fileName pattern to be used when writing out fits files.

setImageDataFileNamePatter

@Deprecated
public void setImageDataFileNamePatter(String imageDataFileNamePattern)

Deprecated.

Setter method for the image data file name patter.

Parameters:

imageDataFileNamePattern - The fileName pattern to be used when writing out image data files.