![]()  | 
  
    Isis 3 Programmer Reference
    
   | 
 
Convert between parent image (aka encoder aka machine) coordinates and detector coordinates. More...
#include <ApolloPanoramicDetectorMap.h>


Public Member Functions | |
| ApolloPanoramicDetectorMap (Camera *parent, double etMiddle, double lineRate, Pvl *lab) | |
| Construct a detector map for line scan cameras.   | |
| virtual | ~ApolloPanoramicDetectorMap () | 
| Destroys ApolloPanoramicDetectorMap object.   | |
| virtual bool | SetParent (const double sample, const double line) | 
| This method sets dector sample line coordinates from given cube coordinates.   | |
| virtual bool | SetDetector (const double sample, const double line) | 
| This method sets cube sample line coordinates from given Dector coordinates.   | |
| void | SetLineRate (const double lineRate) | 
| Reset the line rate.   | |
| double | LineRate () const | 
| Return the time in seconds between scan lines.   | |
| double | meanResidual () | 
| Mean (average) of interior orientation residual vector lengths, accesor.   | |
| double | maxResidual () | 
| Max interior orientation residual vector length, accesor.   | |
| double | stdevResidual () | 
| Standard deviation of interior orientation residual vector lengths, accesor.   | |
| virtual bool | SetParent (const double sample, const double line, const double deltaT) | 
| Compute detector position from a parent image coordinate.   | |
| double | AdjustedStartingSample () const | 
| Return the starting detector sample adjusted for summation.   | |
| double | AdjustedStartingLine () const | 
| Return the starting detector line adjusted for summation.   | |
| double | ParentSample () const | 
| Return parent sample.   | |
| double | ParentLine () const | 
| Return parent line.   | |
| double | DetectorSample () const | 
| Return detector sample.   | |
| double | DetectorLine () const | 
| Return detector line.   | |
| void | SetStartingDetectorSample (const double sample) | 
| Set the starting detector sample.   | |
| void | SetStartingDetectorLine (const double line) | 
| Set the starting detector line.   | |
| void | SetDetectorSampleSumming (const double summing) | 
| Set sample summing mode.   | |
| void | SetDetectorLineSumming (const double summing) | 
| Set line summing mode.   | |
| virtual double | SampleScaleFactor () const | 
| Return scaling factor for computing sample resolution.   | |
| virtual double | LineScaleFactor () const | 
| Return scaling factor for computing line resolution.   | |
| virtual double | exposureDuration (const double sample, const double line, const int band) const | 
| This virtual method is for returning the exposure duration of a given pixel.   | |
Protected Attributes | |
| Camera * | p_camera | 
| Pointer to the camera.   | |
| double | p_parentSample | 
| The parent sample calculated from the detector.   | |
| double | p_parentLine | 
| The parent line calculated from the detector.   | |
| double | p_detectorLine | 
| Detector coordinate line value.   | |
| double | p_detectorSample | 
| Detector coordinate sample value.   | |
| double | p_detectorSampleSumming | 
| The scaling factor for computing sample resolution.   | |
| double | p_detectorLineSumming | 
| The scaling factor for computing line resolution.   | |
| double | p_startingDetectorSample | 
| Detector start coordinate sample value.   | |
| double | p_startingDetectorLine | 
| Detector start coordinate line value.   | |
| double | p_ss | 
| Start sample.   | |
| double | p_sl | 
| Start line.   | |
Private Member Functions | |
| int | initializeInteriorOrientation () | 
| This method uses the ApolloPanIO class to compute transforamtion from cube to image (aka fiducial cooraintes)   | |
| void | Compute () | 
| Compute new offsets whenenver summing or starting sample/lines change.   | |
Private Attributes | |
| double | m_etMiddle | 
| Ephemeris time at the middle line.   | |
| double | m_lineRate | 
| line exposure duration   | |
| Pvl * | m_lab | 
| Image label used to construct camera object.   | |
| ApolloPanIO | p_intOri | 
| Class to preform transformations from cube coordiantes to image coordinates.   | |
Convert between parent image (aka encoder aka machine) coordinates and detector coordinates.
This class is used to convert between parent image (aka encoder aka machine) coordinates (sample/line) and detector coordinates for a the Apollo Panoramic Image.
2011-11-21 Orrin Thomas - Original version
2012-07-10 Orrin Thomas - Updated to current coding standards
2017-06-28 Makayla Shepherd - Updated documentation. References #4807.
Definition at line 32 of file ApolloPanoramicDetectorMap.h.
      
  | 
  inline | 
Construct a detector map for line scan cameras.
| parent | The parent Camera Model | 
| etMiddle | Time of the center line, line 0 after interior orientation | 
| lineRate | the time in seconds between lines (msec) | 
| lab | The labels to use for the camera creation | 
Definition at line 43 of file ApolloPanoramicDetectorMap.h.
References initializeInteriorOrientation(), m_etMiddle, m_lab, and m_lineRate.
      
  | 
  inlinevirtual | 
Destroys ApolloPanoramicDetectorMap object.
Definition at line 53 of file ApolloPanoramicDetectorMap.h.
      
  | 
  inherited | 
Return the starting detector line adjusted for summation.
Definition at line 123 of file CameraDetectorMap.cpp.
References Isis::CameraDetectorMap::p_sl.
      
  | 
  inherited | 
Return the starting detector sample adjusted for summation.
Definition at line 113 of file CameraDetectorMap.cpp.
References Isis::CameraDetectorMap::p_ss.
      
  | 
  privateinherited | 
Compute new offsets whenenver summing or starting sample/lines change.
Definition at line 99 of file CameraDetectorMap.cpp.
References Isis::CameraDetectorMap::p_detectorLineSumming, Isis::CameraDetectorMap::p_detectorSampleSumming, Isis::CameraDetectorMap::p_sl, Isis::CameraDetectorMap::p_ss, Isis::CameraDetectorMap::p_startingDetectorLine, and Isis::CameraDetectorMap::p_startingDetectorSample.
Referenced by Isis::CameraDetectorMap::CameraDetectorMap(), Isis::CameraDetectorMap::SetDetectorLineSumming(), Isis::CameraDetectorMap::SetDetectorSampleSumming(), Isis::CameraDetectorMap::SetStartingDetectorLine(), and Isis::CameraDetectorMap::SetStartingDetectorSample().
      
  | 
  inherited | 
Return detector line.
Definition at line 163 of file CameraDetectorMap.cpp.
References Isis::CameraDetectorMap::p_detectorLine.
Referenced by Isis::Camera::SetImage(), and Isis::Camera::SetImage().
      
  | 
  inherited | 
Return detector sample.
Definition at line 153 of file CameraDetectorMap.cpp.
References Isis::CameraDetectorMap::p_detectorSample.
Referenced by Isis::Camera::SetImage(), and Isis::Camera::SetImage().
      
  | 
  virtualinherited | 
This virtual method is for returning the exposure duration of a given pixel.
For framing cameras, exposure duration is not available so it throws an error.
| sample | The sample of the desired pixel. | 
| line | The line of the desired pixel. | 
| band | The band of the desired pixel. | 
| IException::Programmer | "Exposure duration is only available for LineScan, VariableLineScan, and PushFrame Cameras." | 
Reimplemented in Isis::LineScanCameraDetectorMap, Isis::PushFrameCameraDetectorMap, Isis::VariableLineScanCameraDetectorMap, and Isis::NirsDetectorMap.
Definition at line 212 of file CameraDetectorMap.cpp.
References Isis::IException::Programmer.
Referenced by Isis::Camera::exposureDuration(), and Isis::Camera::exposureDuration().
      
  | 
  private | 
This method uses the ApolloPanIO class to compute transforamtion from cube to image (aka fiducial cooraintes)
| IException::User | "No FID_MEASURES table found in cube blobs." | 
| IException::User | "Less than four FID_MEASURES found in cube blobs." | 
| IException::User | "Insufficient Fiducial Observations for computation of the interior orientation. At least one vertical pair must be measured, many more is recomented." | 
Definition at line 96 of file ApolloPanoramicDetectorMap.cpp.
References Isis::ApolloPanIO::computeInteriorOrienation(), Isis::ApolloPanIO::fiducialObservation(), Isis::PvlContainer::fileName(), Isis::ApolloPanIO::initialize(), m_lab, p_intOri, Isis::Table::Records(), and Isis::IException::User.
Referenced by ApolloPanoramicDetectorMap().
      
  | 
  inlinevirtual | 
Return the time in seconds between scan lines.
Reimplemented from Isis::CameraDetectorMap.
Definition at line 77 of file ApolloPanoramicDetectorMap.h.
References m_lineRate.
      
  | 
  virtualinherited | 
Return scaling factor for computing line resolution.
Definition at line 183 of file CameraDetectorMap.cpp.
References Isis::CameraDetectorMap::p_detectorLineSumming.
Referenced by Isis::Camera::LineResolution(), Isis::Camera::ObliqueLineResolution(), Isis::ThemisIrCamera::SetBand(), Isis::PushFrameCameraDetectorMap::SetDetector(), Isis::PushFrameCameraDetectorMap::SetParent(), and Isis::PushFrameCameraDetectorMap::TotalFramelets().
      
  | 
  inline | 
Max interior orientation residual vector length, accesor.
Definition at line 93 of file ApolloPanoramicDetectorMap.h.
References Isis::ApolloPanIO::maxResiduals(), and p_intOri.
Referenced by Isis::ApolloPanoramicCamera::ApolloPanoramicCamera().
      
  | 
  inline | 
Mean (average) of interior orientation residual vector lengths, accesor.
Definition at line 86 of file ApolloPanoramicDetectorMap.h.
References Isis::ApolloPanIO::meanResiduals(), and p_intOri.
Referenced by Isis::ApolloPanoramicCamera::ApolloPanoramicCamera().
      
  | 
  inherited | 
Return parent line.
Definition at line 143 of file CameraDetectorMap.cpp.
References Isis::CameraDetectorMap::p_parentLine.
Referenced by Isis::Camera::RawFocalPlanetoImage(), and Isis::Camera::SetRightAscensionDeclination().
      
  | 
  inherited | 
Return parent sample.
Definition at line 133 of file CameraDetectorMap.cpp.
References Isis::CameraDetectorMap::p_parentSample.
Referenced by Isis::Camera::RawFocalPlanetoImage(), and Isis::Camera::SetRightAscensionDeclination().
      
  | 
  virtualinherited | 
Return scaling factor for computing sample resolution.
Definition at line 173 of file CameraDetectorMap.cpp.
References Isis::CameraDetectorMap::p_detectorSampleSumming.
Referenced by Isis::Camera::ObliqueSampleResolution(), and Isis::Camera::SampleResolution().
      
  | 
  virtual | 
This method sets cube sample line coordinates from given Dector coordinates.
| sample | dector sample coordinate | 
| line | detector line coordinate | 
Reimplemented from Isis::CameraDetectorMap.
Definition at line 29 of file ApolloPanoramicDetectorMap.cpp.
References Isis::iTime::Et(), Isis::ApolloPanIO::image2Machine(), m_etMiddle, m_lineRate, Isis::CameraDetectorMap::p_camera, Isis::CameraDetectorMap::p_detectorLine, Isis::CameraDetectorMap::p_detectorSample, p_intOri, Isis::CameraDetectorMap::p_parentLine, Isis::CameraDetectorMap::p_parentSample, and Isis::Spice::time().
      
  | 
  inlineinherited | 
Set line summing mode.
Use this method to specify if detector lines are summed/averaged. That is, one image lines represents the average of N detectors. If not set the default is 1.
| summing | Line summing mode | 
Definition at line 123 of file CameraDetectorMap.h.
References Isis::CameraDetectorMap::Compute(), and Isis::CameraDetectorMap::p_detectorLineSumming.
Referenced by Isis::CrismCamera::CrismCamera().
      
  | 
  inlineinherited | 
Set sample summing mode.
Use this method to specify if detector samples are summed/averaged. That is, one image sample represents the average of N detectors. If not set the default is 1.
| summing | Sample summing mode | 
Definition at line 108 of file CameraDetectorMap.h.
References Isis::CameraDetectorMap::Compute(), and Isis::CameraDetectorMap::p_detectorSampleSumming.
Referenced by Isis::ApolloPanoramicCamera::ApolloPanoramicCamera(), Isis::CrismCamera::CrismCamera(), Isis::DawnVirCamera::DawnVirCamera(), Isis::HrscCamera::HrscCamera(), and Isis::RosettaVirtisCamera::RosettaVirtisCamera().
      
  | 
  inline | 
Reset the line rate.
Use this method to reset the time between lines. Usually this will not need to be done unless the rate changes between bands.
| lineRate | the time in seconds between lines | 
Definition at line 68 of file ApolloPanoramicDetectorMap.h.
References m_lineRate.
      
  | 
  virtual | 
This method sets dector sample line coordinates from given cube coordinates.
| sample | cube sample coordinate | 
| line | cube line coordinate | 
Reimplemented from Isis::CameraDetectorMap.
Definition at line 58 of file ApolloPanoramicDetectorMap.cpp.
References m_etMiddle, m_lineRate, Isis::ApolloPanIO::machine2Image(), Isis::CameraDetectorMap::p_camera, Isis::CameraDetectorMap::p_detectorLine, Isis::CameraDetectorMap::p_detectorSample, p_intOri, Isis::CameraDetectorMap::p_parentLine, Isis::CameraDetectorMap::p_parentSample, and Isis::Sensor::setTime().
      
  | 
  virtualinherited | 
Compute detector position from a parent image coordinate.
This method will compute the detector position from the parent line/sample coordinate and an offset from the currently set time in seconds. If the time has not already been set, the input offset is not applied. 
| sample | Sample number in the parent image | 
| line | Line number in the parent image | 
| deltaT | option time offset from center of exposure in seconds | 
Reimplemented in Isis::LineScanCameraDetectorMap, Isis::PushFrameCameraDetectorMap, Isis::RollingShutterCameraDetectorMap, and Isis::VariableLineScanCameraDetectorMap.
Definition at line 82 of file CameraDetectorMap.cpp.
References Isis::Spice::isTimeSet(), Isis::CameraDetectorMap::p_camera, Isis::CameraDetectorMap::p_detectorLine, Isis::CameraDetectorMap::p_detectorLineSumming, Isis::CameraDetectorMap::p_detectorSample, Isis::CameraDetectorMap::p_detectorSampleSumming, Isis::CameraDetectorMap::p_parentLine, Isis::CameraDetectorMap::p_parentSample, Isis::CameraDetectorMap::p_sl, Isis::CameraDetectorMap::p_ss, Isis::Sensor::setTime(), and Isis::Spice::time().
      
  | 
  inlineinherited | 
Set the starting detector line.
Use this method to specify the starting detector that represents the first image line in the cube. If not set the default is 1.
| line | Starting detector line | 
Definition at line 93 of file CameraDetectorMap.h.
References Isis::CameraDetectorMap::Compute(), and Isis::CameraDetectorMap::p_startingDetectorLine.
      
  | 
  inlineinherited | 
Set the starting detector sample.
Use this method to specify the starting detector that represents the first image sample in the cube. If not set the default is 1.
| sample | Starting detector sample | 
Definition at line 79 of file CameraDetectorMap.h.
References Isis::CameraDetectorMap::Compute(), and Isis::CameraDetectorMap::p_startingDetectorSample.
Referenced by Isis::ApolloPanoramicCamera::ApolloPanoramicCamera().
      
  | 
  inline | 
Standard deviation of interior orientation residual vector lengths, accesor.
Definition at line 100 of file ApolloPanoramicDetectorMap.h.
References p_intOri, and Isis::ApolloPanIO::stdevResiduals().
Referenced by Isis::ApolloPanoramicCamera::ApolloPanoramicCamera().
      
  | 
  private | 
Ephemeris time at the middle line.
Definition at line 104 of file ApolloPanoramicDetectorMap.h.
Referenced by ApolloPanoramicDetectorMap(), SetDetector(), and SetParent().
      
  | 
  private | 
Image label used to construct camera object.
Definition at line 106 of file ApolloPanoramicDetectorMap.h.
Referenced by ApolloPanoramicDetectorMap(), and initializeInteriorOrientation().
      
  | 
  private | 
line exposure duration
Definition at line 105 of file ApolloPanoramicDetectorMap.h.
Referenced by ApolloPanoramicDetectorMap(), LineRate(), SetDetector(), SetLineRate(), and SetParent().
      
  | 
  protectedinherited | 
Pointer to the camera.
Definition at line 138 of file CameraDetectorMap.h.
Referenced by Isis::CameraDetectorMap::CameraDetectorMap(), SetDetector(), Isis::LineScanCameraDetectorMap::SetDetector(), Isis::RadarPulseMap::SetDetector(), Isis::VariableLineScanCameraDetectorMap::SetDetector(), Isis::PushFrameCameraDetectorMap::SetFramelet(), SetParent(), Isis::RadarPulseMap::SetParent(), Isis::MocWideAngleDetectorMap::SetParent(), Isis::CameraDetectorMap::SetParent(), Isis::LineScanCameraDetectorMap::SetParent(), Isis::RollingShutterCameraDetectorMap::SetParent(), Isis::VariableLineScanCameraDetectorMap::SetParent(), and Isis::PushFrameCameraDetectorMap::TotalFramelets().
      
  | 
  protectedinherited | 
Detector coordinate line value.
Definition at line 142 of file CameraDetectorMap.h.
Referenced by Isis::CameraDetectorMap::DetectorLine(), SetDetector(), Isis::CameraDetectorMap::SetDetector(), Isis::PushFrameCameraDetectorMap::SetDetector(), Isis::RollingShutterCameraDetectorMap::SetDetector(), SetParent(), Isis::RadarPulseMap::SetParent(), Isis::CameraDetectorMap::SetParent(), Isis::LineScanCameraDetectorMap::SetParent(), Isis::PushFrameCameraDetectorMap::SetParent(), Isis::RollingShutterCameraDetectorMap::SetParent(), and Isis::VariableLineScanCameraDetectorMap::SetParent().
      
  | 
  protectedinherited | 
The scaling factor for computing line resolution.
Definition at line 146 of file CameraDetectorMap.h.
Referenced by Isis::CameraDetectorMap::CameraDetectorMap(), Isis::CameraDetectorMap::Compute(), Isis::CameraDetectorMap::LineScaleFactor(), Isis::CameraDetectorMap::SetDetector(), Isis::RollingShutterCameraDetectorMap::SetDetector(), Isis::CameraDetectorMap::SetDetectorLineSumming(), Isis::CameraDetectorMap::SetParent(), and Isis::RollingShutterCameraDetectorMap::SetParent().
      
  | 
  protectedinherited | 
Detector coordinate sample value.
Definition at line 143 of file CameraDetectorMap.h.
Referenced by Isis::CameraDetectorMap::DetectorSample(), SetDetector(), Isis::CameraDetectorMap::SetDetector(), Isis::PushFrameCameraDetectorMap::SetDetector(), Isis::RollingShutterCameraDetectorMap::SetDetector(), SetParent(), Isis::MocWideAngleDetectorMap::SetParent(), Isis::CameraDetectorMap::SetParent(), and Isis::RollingShutterCameraDetectorMap::SetParent().
      
  | 
  protectedinherited | 
The scaling factor for computing sample resolution.
Definition at line 145 of file CameraDetectorMap.h.
Referenced by Isis::CameraDetectorMap::CameraDetectorMap(), Isis::CameraDetectorMap::Compute(), Isis::CameraDetectorMap::SampleScaleFactor(), Isis::CameraDetectorMap::SetDetector(), Isis::RollingShutterCameraDetectorMap::SetDetector(), Isis::CameraDetectorMap::SetDetectorSampleSumming(), Isis::CameraDetectorMap::SetParent(), and Isis::RollingShutterCameraDetectorMap::SetParent().
      
  | 
  private | 
Class to preform transformations from cube coordiantes to image coordinates.
Definition at line 111 of file ApolloPanoramicDetectorMap.h.
Referenced by initializeInteriorOrientation(), maxResidual(), meanResidual(), SetDetector(), SetParent(), and stdevResidual().
      
  | 
  protectedinherited | 
The parent line calculated from the detector.
Definition at line 141 of file CameraDetectorMap.h.
Referenced by Isis::CameraDetectorMap::ParentLine(), SetDetector(), Isis::CameraDetectorMap::SetDetector(), Isis::LineScanCameraDetectorMap::SetDetector(), Isis::PushFrameCameraDetectorMap::SetDetector(), Isis::RadarPulseMap::SetDetector(), Isis::RollingShutterCameraDetectorMap::SetDetector(), Isis::VariableLineScanCameraDetectorMap::SetDetector(), SetParent(), Isis::CameraDetectorMap::SetParent(), Isis::PushFrameCameraDetectorMap::SetParent(), and Isis::RollingShutterCameraDetectorMap::SetParent().
      
  | 
  protectedinherited | 
The parent sample calculated from the detector.
Definition at line 140 of file CameraDetectorMap.h.
Referenced by Isis::CameraDetectorMap::ParentSample(), SetDetector(), Isis::CameraDetectorMap::SetDetector(), Isis::RollingShutterCameraDetectorMap::SetDetector(), Isis::MocWideAngleDetectorMap::SetDetector(), SetParent(), Isis::CameraDetectorMap::SetParent(), Isis::PushFrameCameraDetectorMap::SetParent(), and Isis::RollingShutterCameraDetectorMap::SetParent().
      
  | 
  protectedinherited | 
Start line.
Definition at line 151 of file CameraDetectorMap.h.
Referenced by Isis::CameraDetectorMap::AdjustedStartingLine(), Isis::CameraDetectorMap::Compute(), Isis::CameraDetectorMap::SetDetector(), Isis::RollingShutterCameraDetectorMap::SetDetector(), Isis::CameraDetectorMap::SetParent(), and Isis::RollingShutterCameraDetectorMap::SetParent().
      
  | 
  protectedinherited | 
Start sample.
Definition at line 150 of file CameraDetectorMap.h.
Referenced by Isis::CameraDetectorMap::AdjustedStartingSample(), Isis::CameraDetectorMap::Compute(), Isis::CameraDetectorMap::SetDetector(), Isis::RollingShutterCameraDetectorMap::SetDetector(), Isis::CameraDetectorMap::SetParent(), and Isis::RollingShutterCameraDetectorMap::SetParent().
      
  | 
  protectedinherited | 
Detector start coordinate line value.
Definition at line 148 of file CameraDetectorMap.h.
Referenced by Isis::CameraDetectorMap::CameraDetectorMap(), Isis::CameraDetectorMap::Compute(), and Isis::CameraDetectorMap::SetStartingDetectorLine().
      
  | 
  protectedinherited | 
Detector start coordinate sample value.
Definition at line 147 of file CameraDetectorMap.h.
Referenced by Isis::CameraDetectorMap::CameraDetectorMap(), Isis::CameraDetectorMap::Compute(), and Isis::CameraDetectorMap::SetStartingDetectorSample().