net.aerith.misao.pixy
Class VariabilityChecker

java.lang.Object
  |
  +--net.aerith.misao.pixy.VariabilityChecker

public class VariabilityChecker
extends java.lang.Object

The VariabilityChecker is a class to check if the magnitude data of a star in the specified database folder shows the variability or not.


Inner Class Summary
protected  class VariabilityChecker.Range
          The Range represents the range of the magnitude.
 
Field Summary
static int BLENDING_BLENDED
          The number of policy on blending which indicates to search variability based on blended magnitude.
static int BLENDING_NOT_CONSIDERED
          The number of policy on blending which indicates to search variability based on measured magnitude.
static int BLENDING_REJECTED
          The number of policy on blending which indicates to reject blending stars.
protected  double brighter_limiting_mag
          The brighter limiting magnitude.
protected  boolean include_discarded
          True if the discarded data are also considered.
protected  boolean include_reported
          True if the reported data are also considered.
protected  int ingore_pixels_from_edge
          The pixels from edge to be ignored.
protected  double magnitude_threshold
          The magnitude threshold.
protected  double period_window_size
          The period window size in days.
protected  int policy_blending
          The policy on blending.
protected  int policy_catalog
          The policy on the catalog element.
protected  int policy_chip
          The policy on the chip element.
static int POLICY_CONSIDERED_EXCLUDING_EMPTY
          The number of policy which indicates to consider the element value, while the records with the empty value are ignored.
static int POLICY_CONSIDERED_INCLUDING_EMPTY
          The number of policy which indicates to consider the element value, while the records with the empty value are regarded as to match any value.
protected  int policy_filter
          The policy on the filter element.
static int POLICY_NOT_CONSIDERED
          The number of policy which indicates not to consider the element value.
 
Constructor Summary
VariabilityChecker()
          Constructs a VariabilityChecker.
 
Method Summary
 Variability check(XmlMagRecord[] records)
          Checks if the specified list of magnitude records shows the variability or not.
protected  XmlMagRecord[] createSubRecordArray(XmlMagRecord[] records, java.lang.String filter, java.lang.String chip, java.lang.String catalog)
          Creates the sub array of the magnitude records whose filter, chip and catalog element correspond to the specified strings.
 int getBlendingPolicy()
          Gets the policy on blending.
 double getBrighterLimitingMagnitude()
          Gets the brighter limiting magnitude.
 void includeDiscarded()
          Considers the discarded data.
 void includeReported()
          Considers the reported data.
protected  boolean isVariable(XmlMagRecord[] records)
          Checks if the specified list of magnitude records shows the variability or not.
 void setBlendingPolicy(int policy)
          Sets the policy on blending.
 void setBrighterLimitingMagnitude(double mag)
          Sets the brighter limiting magnitude.
 void setCatalogPolicy(int policy)
          Sets the policy on the catalog element.
 void setChipPolicy(int policy)
          Sets the policy on the chip element.
 void setFilterPolicy(int policy)
          Sets the policy on the filter element.
 void setIgnoredPixelsFromEdge(int pixels)
          Sets the pixels from edge to be ignored.
 void setMagnitudeThreshold(double threshold)
          Sets the magnitude threshold.
 void setPeriodWindowSize(double period)
          Sets the period window size in days.
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 

Field Detail

POLICY_NOT_CONSIDERED

public static final int POLICY_NOT_CONSIDERED
The number of policy which indicates not to consider the element value.

POLICY_CONSIDERED_INCLUDING_EMPTY

public static final int POLICY_CONSIDERED_INCLUDING_EMPTY
The number of policy which indicates to consider the element value, while the records with the empty value are regarded as to match any value.

POLICY_CONSIDERED_EXCLUDING_EMPTY

public static final int POLICY_CONSIDERED_EXCLUDING_EMPTY
The number of policy which indicates to consider the element value, while the records with the empty value are ignored.

BLENDING_NOT_CONSIDERED

public static final int BLENDING_NOT_CONSIDERED
The number of policy on blending which indicates to search variability based on measured magnitude.

BLENDING_BLENDED

public static final int BLENDING_BLENDED
The number of policy on blending which indicates to search variability based on blended magnitude.

BLENDING_REJECTED

public static final int BLENDING_REJECTED
The number of policy on blending which indicates to reject blending stars.

magnitude_threshold

protected double magnitude_threshold
The magnitude threshold.

brighter_limiting_mag

protected double brighter_limiting_mag
The brighter limiting magnitude. Only stars whose brightest magnitude is brighter than the specified magnitude are selected.

period_window_size

protected double period_window_size
The period window size in days.

policy_filter

protected int policy_filter
The policy on the filter element.

policy_chip

protected int policy_chip
The policy on the chip element.

policy_catalog

protected int policy_catalog
The policy on the catalog element.

policy_blending

protected int policy_blending
The policy on blending.

include_discarded

protected boolean include_discarded
True if the discarded data are also considered.

include_reported

protected boolean include_reported
True if the reported data are also considered.

ingore_pixels_from_edge

protected int ingore_pixels_from_edge
The pixels from edge to be ignored.
Constructor Detail

VariabilityChecker

public VariabilityChecker()
Constructs a VariabilityChecker.
Method Detail

setMagnitudeThreshold

public void setMagnitudeThreshold(double threshold)
Sets the magnitude threshold.
Parameters:
threshold - the magnitude threshold.

setBrighterLimitingMagnitude

public void setBrighterLimitingMagnitude(double mag)
Sets the brighter limiting magnitude. Only stars whose brightest magnitude is brighter than the specified magnitude are selected.
Parameters:
mag - the brighter limiting magnitude.

getBrighterLimitingMagnitude

public double getBrighterLimitingMagnitude()
Gets the brighter limiting magnitude.
Returns:
the brighter limiting magnitude.

setPeriodWindowSize

public void setPeriodWindowSize(double period)
Sets the period window size in days.
Parameters:
period - the period window size in days.

setFilterPolicy

public void setFilterPolicy(int policy)
Sets the policy on the filter element.
Parameters:
policy - the number of policy.

setChipPolicy

public void setChipPolicy(int policy)
Sets the policy on the chip element.
Parameters:
policy - the number of policy.

setCatalogPolicy

public void setCatalogPolicy(int policy)
Sets the policy on the catalog element.
Parameters:
policy - the number of policy.

getBlendingPolicy

public int getBlendingPolicy()
Gets the policy on blending.
Returns:
the number of policy on blending.

setBlendingPolicy

public void setBlendingPolicy(int policy)
Sets the policy on blending.
Parameters:
policy - the number of policy on blending.

includeDiscarded

public void includeDiscarded()
Considers the discarded data.

includeReported

public void includeReported()
Considers the reported data.

setIgnoredPixelsFromEdge

public void setIgnoredPixelsFromEdge(int pixels)
Sets the pixels from edge to be ignored.
Parameters:
pixels - the pixels from edge to be ignored.

check

public Variability check(XmlMagRecord[] records)
Checks if the specified list of magnitude records shows the variability or not.
Parameters:
records - the list of magnitude records.
Returns:
the set of brightest and faintest magnitude element if the records show the variability, otherwise null.

createSubRecordArray

protected XmlMagRecord[] createSubRecordArray(XmlMagRecord[] records,
                                              java.lang.String filter,
                                              java.lang.String chip,
                                              java.lang.String catalog)
Creates the sub array of the magnitude records whose filter, chip and catalog element correspond to the specified strings.
Parameters:
records - the list of magnitude records.
filter - the filter.
chip - the chip.
catalog - the catalog.
Returns:
the sub array of the magnitude records.

isVariable

protected boolean isVariable(XmlMagRecord[] records)
Checks if the specified list of magnitude records shows the variability or not.
Parameters:
records - the list of magnitude records.
Returns:
true if the specified list of magnitude records shows the variability.