swisseph

Class TCPlanet

java.lang.Object

swisseph.TransitCalculator

swisseph.TCPlanet

All Implemented Interfaces:

java.io.Serializable

public class TCPlanet
extends TransitCalculator
implements java.io.Serializable

This class implements a TransitCalculator for one planet's position or speed.

You would create a TransitCalculator from this class and use the SwissEph.getTransit() methods to actually calculate a transit, e.g.:

 SwissEph sw = new SwissEph(...);
 ...
 int flags = SweConst.SEFLG_SWIEPH |
             SweConst.SEFLG_TRANSIT_LONGITUDE |
             SweConst.SEFLG_TRANSIT_SPEED;
 boolean backwards = false;
 
 TransitCalculator tc = new TCPlanet(
                                  sw,
                                  SweConst.SE_SATURN,
                                  flags,
                                  0);
 ...
 double nextTransitET = sw.getTransitET(tc, jdET, backwards);
 

This would calculate the (ET-) date, when the Saturn will change from retrograde to direct movement or vice versa.

See Also:

Serialized Form

Field Summary

Fields inherited from class swisseph.TransitCalculator

rollover, rolloverVal

Constructor Summary

Constructors

Constructor and Description
TCPlanet(SwissEph sw, int planet, int flags, double offset) Creates a new TransitCalculator for transits of any of the planet's positions (longitudinal / latitudinal and distance) or speeds, be it in the geocentric or topocentric coordinate system, or in tropical or sidereal zodiac.
TCPlanet(SwissEph sw, int planet, int flags, double offset, int precalcCount, double precalcSafetyfactor) Creates a new TransitCalculator for transits of any of the planets positions (longitudinal / latitudinal and distance) or speeds, be it in the geocentric or topocentric coordinate system, or in tropical or sidereal zodiac.

Method Summary

Modifier and Type	Method and Description
protected double	calc(double jdET)
protected double	getDegreePrecision(double jd)
double	getMaxOffset()
protected double	getMaxSpeed()
double	getMinOffset()
protected double	getMinSpeed()
java.lang.Object[]	getObjectIdentifiers() This returns the planet number as an Integer object.
double	getOffset() This returns the degree or other value of the position or speed of the planet to transit.
boolean	getRollover()
protected double	getTimePrecision(double degPrec)
void	setOffset(double value) This sets the degree or other value for the position or speed of the planet to transit.
java.lang.String	toString()

Methods inherited from class swisseph.TransitCalculator

checkIdenticalResult, checkResult, getNextJD, getRolloverVal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TCPlanet

public TCPlanet(SwissEph sw,
                int planet,
                int flags,
                double offset)

Creates a new TransitCalculator for transits of any of the planet's positions (longitudinal / latitudinal and distance) or speeds, be it in the geocentric or topocentric coordinate system, or in tropical or sidereal zodiac.

Parameters:

sw - A SwissEph object, if you have one available. May be null, if you don't use sidereal or topocentric mode.
If you use sidereal or topocentric mode, you have to make sure to set the sidereal mode or topocentric location before the transit calculations.

planet - The transiting planet or object number.
Planets from SweConst.SE_SUN up to SweConst.SE_INTP_PERG (with the exception of SweConst.SE_EARTH) have their extreme speeds saved, so these extreme speeds will be used on calculation.
Other objects calculate extreme speeds by randomly calculating by default 200 speed values and multiply them by 1.4 as a safety factor.
ATTENTION: be sure to understand that you might be able to miss some transit or you might get a rather bad transit time in very rare circumstances.
Use SweConst.SE_AST_OFFSET + asteroid number for planets with a planet number not defined by SweConst.SEFLG_*.

flags - The calculation type flags (SweConst.SEFLG_TRANSIT_LONGITUDE, SweConst.SEFLG_TRANSIT_LATITUDE or SweConst.SEFLG_TRANSIT_DISTANCE in conjunction with SweConst.SEFLG_TRANSIT_SPEED for transits over a speed value).

Also flags modifying the basic planet calculations, these are SweConst.SEFLG_TOPOCTR, SweConst.SEFLG_EQUATORIAL, SweConst.SEFLG_HELCTR, SweConst.SEFLG_TRUEPOS, and SweConst.SEFLG_SIDEREAL, plus the optional ephemeris flags SweConst.SEFLG_MOSEPH, SweConst.SEFLG_SWIEPH or SweConst.SEFLG_JPLEPH optionally.
For right ascension use SEFLG_TRANSIT_LONGITUDE | SEFLG_EQUATORIAL, for declination SEFLG_TRANSIT_LATITUDE | SEFLG_EQUATORIAL.

offset - This is the desired transit degree or distance in AU or transit speed in deg/day.

See Also:

TCPlanetPlanet.TCPlanetPlanet(SwissEph, int, int, int, double), TCPlanet(SwissEph, int, int, double, int, double), SweConst.SEFLG_TRANSIT_LONGITUDE, SweConst.SEFLG_TRANSIT_LATITUDE, SweConst.SEFLG_TRANSIT_DISTANCE, SweConst.SEFLG_TRANSIT_SPEED, SweConst.SEFLG_YOGA_TRANSIT, SweConst.SE_AST_OFFSET, SweConst.SEFLG_TOPOCTR, SweConst.SEFLG_EQUATORIAL, SweConst.SEFLG_HELCTR, SweConst.SEFLG_TRUEPOS, SweConst.SEFLG_SIDEREAL, SweConst.SEFLG_MOSEPH, SweConst.SEFLG_SWIEPH, SweConst.SEFLG_JPLEPH

TCPlanet

public TCPlanet(SwissEph sw,
                int planet,
                int flags,
                double offset,
                int precalcCount,
                double precalcSafetyfactor)

Creates a new TransitCalculator for transits of any of the planets positions (longitudinal / latitudinal and distance) or speeds, be it in the geocentric or topocentric coordinate system, or in tropical or sidereal zodiac.

Parameters:

sw - A SwissEph object, if you have one available. May be null, if you don't use sidereal or topocentric mode.
If you use sidereal or topocentric mode, you have to make sure to set the sidereal mode or topocentric location before the transit calculations.

planet - The transiting planet or object number.
Planets from SweConst.SE_SUN up to SweConst.SE_INTP_PERG (with the exception of SweConst.SE_EARTH) have their extreme speeds saved, so these extreme speeds will be used on calculation.
Other objects calculate extreme speeds by randomly calculating by default 200 speed values and multiply them by 1.4 as a safety factor.
ATTENTION: be sure to understand that you might be able to miss some transit on these other objects or you might get a rather bad transit time in very rare circumstances.
Changing the amount of 200 pre-calculations will give higher or lower startup time on new TCPlanet(...), changing the 1.4 safety factor will change each single calculation time.
Be careful when reducing the safety factor, as you might miss some transits or get bad transit points sometimes.
Use SweConst.SE_AST_OFFSET + asteroid number for planets with a planet number not defined by SweConst.SEFLG_*.

flags - The calculation type flags (SweConst.SEFLG_TRANSIT_LONGITUDE, SweConst.SEFLG_TRANSIT_LATITUDE or SweConst.SEFLG_TRANSIT_DISTANCE in conjunction with SweConst.SEFLG_TRANSIT_SPEED for transits over a speed value).

Also flags modifying the basic planet calculations, these are SweConst.SEFLG_TOPOCTR, SweConst.SEFLG_EQUATORIAL, SweConst.SEFLG_HELCTR, SweConst.SEFLG_TRUEPOS, and SweConst.SEFLG_SIDEREAL, plus the (optional) ephemeris flags SweConst.SEFLG_MOSEPH, SweConst.SEFLG_SWIEPH or SweConst.SEFLG_JPLEPH.
For right ascension use SEFLG_TRANSIT_LONGITUDE | SEFLG_EQUATORIAL, for declination SEFLG_TRANSIT_LATITUDE | SEFLG_EQUATORIAL.

offset - This is the desired transit degree or distance (in AU) or transit speed (in deg/day or AU/day).

precalcCount - When calculating planets without saved extreme speeds, you may change the default value of 200 random calculations to search for the extreme speeds here.

precalcSafetyfactor - When calculating planets without saved extreme speeds, you may change the default value of 1.4 as a safety factor to be multiplied with the found extreme speeds here.

See Also:

TCPlanetPlanet.TCPlanetPlanet(SwissEph, int, int, int, double), SweConst.SEFLG_TRANSIT_LONGITUDE, SweConst.SEFLG_TRANSIT_LATITUDE, SweConst.SEFLG_TRANSIT_DISTANCE, SweConst.SEFLG_TRANSIT_SPEED, SweConst.SEFLG_YOGA_TRANSIT, SweConst.SE_AST_OFFSET, SweConst.SEFLG_TOPOCTR, SweConst.SEFLG_EQUATORIAL, SweConst.SEFLG_HELCTR, SweConst.SEFLG_TRUEPOS, SweConst.SEFLG_SIDEREAL, SweConst.SEFLG_MOSEPH, SweConst.SEFLG_SWIEPH, SweConst.SEFLG_JPLEPH

Method Detail

getRollover

public boolean getRollover()

Specified by:

getRollover in class TransitCalculator

Returns:

Returns true, if one position value is identical to another position value. E.g., 360 degree is identical to 0 degree in circular angles.

See Also:

TransitCalculator.rolloverVal

getMinOffset

public double getMinOffset()

Overrides:

getMinOffset in class TransitCalculator

Returns:

Returns the lowest possible offset value.

getMaxOffset

public double getMaxOffset()

Overrides:

getMaxOffset in class TransitCalculator

Returns:

Returns the highest possible offset value.

setOffset

public void setOffset(double value)

This sets the degree or other value for the position or speed of the planet to transit. It will be used on the next call to getTransit().

Specified by:

setOffset in class TransitCalculator

Parameters:

value - The desired offset value.

See Also:

getOffset()

getOffset

public double getOffset()

This returns the degree or other value of the position or speed of the planet to transit.

Specified by:

getOffset in class TransitCalculator

Returns:

The currently set offset value.

See Also:

setOffset(double)

getObjectIdentifiers

public java.lang.Object[] getObjectIdentifiers()

This returns the planet number as an Integer object.

Overrides:

getObjectIdentifiers in class TransitCalculator

Returns:

An array of identifiers identifying the calculated objects.

calc

protected double calc(double jdET)

Specified by:

calc in class TransitCalculator

getMaxSpeed

protected double getMaxSpeed()

Specified by:

getMaxSpeed in class TransitCalculator

getMinSpeed

protected double getMinSpeed()

Specified by:

getMinSpeed in class TransitCalculator

getTimePrecision

protected double getTimePrecision(double degPrec)

Specified by:

getTimePrecision in class TransitCalculator

getDegreePrecision

protected double getDegreePrecision(double jd)

Specified by:

getDegreePrecision in class TransitCalculator

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object