DetectionFrameInfo.h

Go to the documentation of this file.

#ifndef _SEIMPLEMENTATION_PLUGIN_DETECTIONFRAMEINFO_DETECTIONFRAMEINFO_H_
#define _SEIMPLEMENTATION_PLUGIN_DETECTIONFRAMEINFO_DETECTIONFRAMEINFO_H_

#include "SEUtils/Types.h"

#include "SEFramework/Property/Property.h"
#include "SEFramework/Image/ImageSource.h"
#include "SEFramework/CoordinateSystem/CoordinateSystem.h"

namespace SourceXtractor {

class DetectionFrameInfo : public Property {

public:
  virtual ~DetectionFrameInfo() = default;

  DetectionFrameInfo(int width, int height, double gain, double saturation,
      double variance_threshold, double background_median_rms, const std::map<std::string,
      MetadataEntry>& metadata = std::map<std::string, MetadataEntry>(), size_t hdu_index=0)
      : m_width(width), m_height(height),
        m_gain(gain), m_saturation(saturation),
        m_variance_threshold(variance_threshold), m_background_median_rms(background_median_rms),
        m_metadata(metadata),
        m_hdu_index(hdu_index) {}

  double getGain() const {
    return m_gain;
  }

  double getSaturation() const {
    return m_saturation;
  }

  int getWidth() const {
    return m_width;
  }

  int getHeight() const {
    return m_height;
  }

  SeFloat getVarianceThreshold() const {
    return m_variance_threshold;
  }

  SeFloat getBackgroundMedianRms() const {
    return m_background_median_rms;
  }

  // Metadata of the original image
  const std::map<std::string, MetadataEntry>& getMetadata() const {
    return m_metadata;
  };

  size_t getHduIndex() const {
   return m_hdu_index;
  }

private:
  int m_width;
  int m_height;

  double m_gain;
  double m_saturation;

  double m_variance_threshold;
  double m_background_median_rms;

  std::map<std::string, MetadataEntry> m_metadata;
  size_t m_hdu_index;
};

}

#endif /* _SEIMPLEMENTATION_PLUGIN_DETECTIONFRAMEINFO_DETECTIONFRAMEINFO_H_ */