wiki:FormatterIndex
Last modified 11 years ago Last modified on 10/17/2007 03:24:50 PM

Formatter Index

This page lists all known Formatter subclasses for use with the persistence framework, their persistable type names, and the Storage subclasses they work with.

fw Package

DiaSourceVectorFormatter

  • Persistable class name = DiaSourceVector
  • Storage subclasses supported:
    • BoostStorage
    • DbStorage
    • DbTsvStorage (recommended)

ExposureFormatter<ImagePixelT, MaskPixelT>

  • Persistable class names (taken from Python names):
    • ExposureU
    • ExposureF
    • ExposureD
  • Storage subclasses supported:
    • BoostStorage: persists/retrieves images, mask, FITS metadata, WCS, and other internal state.
    • FitsStorage: persists/retrieves images, mask, and FITS metadata (including WCS).
    • DbStorage: persists (only) image location from previous FitsStorage and metadata primarily from FITS.

ImageFormatter<ImagePixelT>

  • Persistable class names (taken from Python names):
    • ImageU
    • ImageF
    • ImageD
  • Storage subclasses supported:
    • BoostStorage: persists/retrieves pixels, FITS metadata, and other internal state.
    • FitsStorage: persists/retrieves pixels and FITS metadata.

MaskFormatter<MaskPixelT>

  • Persistable class name = Mask (boost::uint16_t only)
  • Storage subclasses supported:
    • BoostStorage: persists/retrieves pixels and FITS metadata.
    • FitsStorage: persists/retrieves pixels and FITS metadata.

MaskedImageFormatter<ImagePixelT, MaskPixelT>

  • Persistable class names (taken from Python names):
    • MaskedImageU
    • MaskedImageF
    • MaskedImageD
  • Storage subclasses supported:
    • BoostStorage: persists/retrieves images, mask, FITS metadata, and other internal state.
    • FitsStorage: persists/retrieves images, mask, and FITS metadata.

MovingObjectPredictionVectorFormatter

  • Persistable class name = MovingObjectPredictionVector
  • Storage subclasses supported:
    • BoostStorage
    • DbStorage
    • DbTsvStorage (recommended)

WcsFormatter

  • Persistable class name = WCS
  • Storage subclasses supported:
    • BoostStorage: persists/retrieves key FITS header equivalents:
      • NAXIS
      • EQUINOX
      • RADECSYS
      • CRPIX1, CRPIX2
      • CD1_1, CD1_2, CD2_1, CD2_2
      • CRVAL1, CRVAL2
      • CUNIT1, CUNIT2
      • CTYPE1, CTYPE2
  • Auxiliary methods:
    • DataProperty::PtrType generateDataProperty(WCS const& wcs); generates a DataProperty with the above WCS keywords set.

mwi Package

DataPropertyFormatter

  • Persistable class name = DataProperty
  • Storage subclasses supported:
    • BoostStorage (recommended)
    • XmlStorage: primarily as an example