Package org.ivoa.dm.caom2

Class Metrics

java.lang.Object
org.ivoa.dm.caom2.Metrics
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="caom2:Metrics", role=objectType) public class Metrics extends Object implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
collection of measured quantities that describe the content of the data. objectType: Metrics

  • Field Details

    • _id

      protected Long _id
      inserted database key

    • sourceNumberDensity

      @VoDml(id="caom2:Metrics.sourceNumberDensity", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double sourceNumberDensity
      number of sources detected per unit area. : Attribute sourceNumberDensity : multiplicity 0..1

    • background

      @VoDml(id="caom2:Metrics.background", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double background
      background level. : Attribute background : multiplicity 0..1

    • backgroundStddev

      @VoDml(id="caom2:Metrics.backgroundStddev", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double backgroundStddev
      standard deviation in the background level. : Attribute backgroundStddev : multiplicity 0..1

    • fluxDensityLimit

      @VoDml(id="caom2:Metrics.fluxDensityLimit", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double fluxDensityLimit
      flux density with a signal:noise ratio of 10. : Attribute fluxDensityLimit : multiplicity 0..1

    • magLimit

      @VoDml(id="caom2:Metrics.magLimit", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double magLimit
      magnitude with a signal:noise ratio of 10. : Attribute magLimit : multiplicity 0..1

    • sampleSNR

      @VoDml(id="caom2:Metrics.sampleSNR", role=attribute, type="ivoa:real", typeRole=primitiveType) protected Double sampleSNR
      signal:noise ratio for a representative subset of samples. : Attribute sampleSNR : multiplicity 0..1

  • Constructor Details

    • Metrics

      public Metrics()
      Creates a new Metrics

    • Metrics

      public Metrics(Double sourceNumberDensity, Double background, Double backgroundStddev, Double fluxDensityLimit, Double magLimit, Double sampleSNR)
      full parameter constructor.
      Parameters:
      sourceNumberDensity - number of sources detected per unit area.
      background - background level.
      backgroundStddev - standard deviation in the background level.
      fluxDensityLimit - flux density with a signal:noise ratio of 10.
      magLimit - magnitude with a signal:noise ratio of 10.
      sampleSNR - signal:noise ratio for a representative subset of samples.

    • Metrics

      public Metrics(Metrics other)
      Copy Constructor. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

  • Method Details

    • getId

      public Long getId()
      Specified by:
      getId in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
      Returns:
      the id

    • updateUsing

      public void updateUsing(Metrics other)
      Update this object with the content of the given object. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

    • getSourceNumberDensity

      public Double getSourceNumberDensity()
      Returns sourceNumberDensity Attribute.
      Returns:
      sourceNumberDensity Attribute

    • setSourceNumberDensity

      public void setSourceNumberDensity(Double pSourceNumberDensity)
      Set sourceNumberDensity Attribute.
      Parameters:
      pSourceNumberDensity - value to set

    • withSourceNumberDensity

      public Metrics withSourceNumberDensity(Double pSourceNumberDensity)
      fluent setter for sourceNumberDensity Attribute.
      Parameters:
      pSourceNumberDensity - value to set
      Returns:
      Metrics

    • getBackground

      public Double getBackground()
      Returns background Attribute.
      Returns:
      background Attribute

    • setBackground

      public void setBackground(Double pBackground)
      Set background Attribute.
      Parameters:
      pBackground - value to set

    • withBackground

      public Metrics withBackground(Double pBackground)
      fluent setter for background Attribute.
      Parameters:
      pBackground - value to set
      Returns:
      Metrics

    • getBackgroundStddev

      public Double getBackgroundStddev()
      Returns backgroundStddev Attribute.
      Returns:
      backgroundStddev Attribute

    • setBackgroundStddev

      public void setBackgroundStddev(Double pBackgroundStddev)
      Set backgroundStddev Attribute.
      Parameters:
      pBackgroundStddev - value to set

    • withBackgroundStddev

      public Metrics withBackgroundStddev(Double pBackgroundStddev)
      fluent setter for backgroundStddev Attribute.
      Parameters:
      pBackgroundStddev - value to set
      Returns:
      Metrics

    • getFluxDensityLimit

      public Double getFluxDensityLimit()
      Returns fluxDensityLimit Attribute.
      Returns:
      fluxDensityLimit Attribute

    • setFluxDensityLimit

      public void setFluxDensityLimit(Double pFluxDensityLimit)
      Set fluxDensityLimit Attribute.
      Parameters:
      pFluxDensityLimit - value to set

    • withFluxDensityLimit

      public Metrics withFluxDensityLimit(Double pFluxDensityLimit)
      fluent setter for fluxDensityLimit Attribute.
      Parameters:
      pFluxDensityLimit - value to set
      Returns:
      Metrics

    • getMagLimit

      public Double getMagLimit()
      Returns magLimit Attribute.
      Returns:
      magLimit Attribute

    • setMagLimit

      public void setMagLimit(Double pMagLimit)
      Set magLimit Attribute.
      Parameters:
      pMagLimit - value to set

    • withMagLimit

      public Metrics withMagLimit(Double pMagLimit)
      fluent setter for magLimit Attribute.
      Parameters:
      pMagLimit - value to set
      Returns:
      Metrics

    • getSampleSNR

      public Double getSampleSNR()
      Returns sampleSNR Attribute.
      Returns:
      sampleSNR Attribute

    • setSampleSNR

      public void setSampleSNR(Double pSampleSNR)
      Set sampleSNR Attribute.
      Parameters:
      pSampleSNR - value to set

    • withSampleSNR

      public Metrics withSampleSNR(Double pSampleSNR)
      fluent setter for sampleSNR Attribute.
      Parameters:
      pSampleSNR - value to set
      Returns:
      Metrics

    • createMetrics

      public static Metrics createMetrics(Consumer<Metrics.MetricsBuilder> f)
      create a Metrics in functional builder style.
      Parameters:
      f - the functional builder.
      Returns:
      an object initialized from the builder.

    • forceLoad

      public void forceLoad()
      Specified by:
      forceLoad in interface org.ivoa.vodml.jpa.JPAManipulations

    • delete

      public void delete(jakarta.persistence.EntityManager em)
      Specified by:
      delete in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>