net.aerith.misao.util
Class PhotometrySetting

java.lang.Object
  |
  +--net.aerith.misao.util.PhotometrySetting

public class PhotometrySetting
extends java.lang.Object

The PhotometrySetting represents a set of magnitude system formula and reference catalog name.


Field Summary
protected  java.lang.String catalog_name
          The catalog name.
protected  java.lang.String description
          The catalog description.
protected  boolean fix_gradient
          True when to compare magnitude by average fitting.
protected  int method
          The method of photometry.
static int METHOD_COMPARISON
          The method of photometry which represents simple magnitude comparison.
static int METHOD_FREE_PHOTOMETRY
          The method of photometry which represents regular photometry calculating the magnitude system formula at the same time.
static int METHOD_INSTRUMENTAL_PHOTOMETRY
          The method of photometry which represents regular photometry using the fixed formula.
static int METHOD_STANDARD
          The method of photometry which represents standard system.
protected  MagnitudeSystem system
          The magnitude system.
 
Constructor Summary
PhotometrySetting(java.lang.String catalog_name)
          Constructs a PhotometrySetting with a catalog name
 
Method Summary
 java.lang.String getCatalogName()
          Gets the catalog name.
 java.lang.String getDescription()
          Returns the catalog description.
 double getGradientBV()
          Gets the gradient of (B-V).
 MagnitudeSystem getMagnitudeSystem()
          Gets the magnitude system.
 int getMethod()
          Gets the method.
 boolean gradientFixed()
          Returns true when not to fix the gradient of the magnitude translation formula.
 void setDescription(java.lang.String description)
          Sets the catalog description.
 void setFixGradient(boolean flag)
          Sets whether to fix the gradient of the magnitude translation formula.
 void setGradientBV(double gradient)
          Sets the gradient of (B-V).
 void setMethod(int method)
          Sets the method.
 void setSystemCode(java.lang.String code)
          Sets the magnitude system code.
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 

Field Detail

METHOD_STANDARD

public static final int METHOD_STANDARD
The method of photometry which represents standard system.

METHOD_INSTRUMENTAL_PHOTOMETRY

public static final int METHOD_INSTRUMENTAL_PHOTOMETRY
The method of photometry which represents regular photometry using the fixed formula.

METHOD_FREE_PHOTOMETRY

public static final int METHOD_FREE_PHOTOMETRY
The method of photometry which represents regular photometry calculating the magnitude system formula at the same time.

METHOD_COMPARISON

public static final int METHOD_COMPARISON
The method of photometry which represents simple magnitude comparison.

method

protected int method
The method of photometry.

fix_gradient

protected boolean fix_gradient
True when to compare magnitude by average fitting.

catalog_name

protected java.lang.String catalog_name
The catalog name. In the case of simple magnitude comparison, the catalog name must contain the magnitude system code.

system

protected MagnitudeSystem system
The magnitude system.

description

protected java.lang.String description
The catalog description.
Constructor Detail

PhotometrySetting

public PhotometrySetting(java.lang.String catalog_name)
Constructs a PhotometrySetting with a catalog name
Parameters:
catalog_name - the catalog name. In the case of simple magnitude comparison, the catalog name must contain the magnitude system code.
Method Detail

getCatalogName

public java.lang.String getCatalogName()
Gets the catalog name.
Returns:
the catalog name.

getMethod

public int getMethod()
Gets the method.
Returns:
the number of method.

setMethod

public void setMethod(int method)
Sets the method.
Parameters:
method - the number of method.

getMagnitudeSystem

public MagnitudeSystem getMagnitudeSystem()
Gets the magnitude system.
Returns:
the magnitude system.

setSystemCode

public void setSystemCode(java.lang.String code)
Sets the magnitude system code.
Parameters:
code - the magnitude system code.

getGradientBV

public double getGradientBV()
Gets the gradient of (B-V).
Returns:
the gradient of (B-V).

setGradientBV

public void setGradientBV(double gradient)
Sets the gradient of (B-V).
Parameters:
gradient - the gradient of (B-V).

setFixGradient

public void setFixGradient(boolean flag)
Sets whether to fix the gradient of the magnitude translation formula.
Parameters:
flag - true when to fix the gradient of the magnitude translation formula.

gradientFixed

public boolean gradientFixed()
Returns true when not to fix the gradient of the magnitude translation formula.
Returns:
true when not to fix the gradient of the magnitude translation formula.

getDescription

public java.lang.String getDescription()
Returns the catalog description. It returns the catalog name by default.
Returns:
the catalog description.

setDescription

public void setDescription(java.lang.String description)
Sets the catalog description.
Parameters:
the - catalog description.