Relativistic Starfield 1.0.0
A B C D E F G H I L M N O P Q R S T U V W X Y 

A

add(String) - Method in exception hirondelle.starfield.physics.InputParameterException
Add a single error message.
add(BoostedStar, double) - Method in class hirondelle.starfield.physics.StarfieldImage
Add a boosted star to the generated image.
alignAllX(Container, UiUtil.AlignX) - Static method in class hirondelle.starfield.util.UiUtil
Imposes a uniform horizontal alignment on all items in a container.
alignAllY(Container, UiUtil.AlignY) - Static method in class hirondelle.starfield.util.UiUtil
Imposes a uniform vertical alignment on all items in a container.
APP_NAME - Static variable in class hirondelle.starfield.util.Consts
 
applyBoostTo(Star, double) - Method in class hirondelle.starfield.physics.Boost
Account for changes the star's direction (aberration), brightness (magnitude), and surface temperature (color).
Args - Class in hirondelle.starfield.util
Utility methods for common argument validations.
Args() - Constructor for class hirondelle.starfield.util.Args
 

B

beep() - Static method in class hirondelle.starfield.util.UiUtil
Make the system emit a beep.
BehrmannProjection - Class in hirondelle.starfield.projection
Whole sky projection, variation of EqualAreaCylindricalProjection.
BehrmannProjection() - Constructor for class hirondelle.starfield.projection.BehrmannProjection
 
Boost - Class in hirondelle.starfield.physics
Apply the physics of a Lorentz Boost to a star.
Boost() - Constructor for class hirondelle.starfield.physics.Boost
 
BoostedStar - Class in hirondelle.starfield.physics
Struct to carry the results of a boost calculation for a star.
BoostedStar() - Constructor for class hirondelle.starfield.physics.BoostedStar
 
BoostTEST - Class in hirondelle.starfield.physics
 
BoostTEST(String) - Constructor for class hirondelle.starfield.physics.BoostTEST
 
BrightnessIndex - Variable in class hirondelle.starfield.physics.StarfieldStats
The brightness index of all the visible stars; a 0-magnitude star contributes a brightness value of 1.
buildAndShow() - Method in class hirondelle.starfield.gui.Screen
Create the main screen, and then show it.

C

calculate() - Method in class hirondelle.starfield.physics.Starfield
Calculate high-level statistics for the starfield using the given input parameters, and output an image.
Catalog - Enum in hirondelle.starfield.catalog.parser
Enumeration of all implemented star catalogs, along with their corresponding RecordParser implementations.
centerAndShow(Window) - Static method in class hirondelle.starfield.util.UiUtil
pack, center, and show a window on the screen.
centerOnParentAndShow(Window) - Static method in class hirondelle.starfield.util.UiUtil
A window is packed, centered with respect to a parent, and then shown.
changeCoordsOfThe(Star) - Method in class hirondelle.starfield.physics.DirectionOfMotion
Change the right ascension and declination of a Star to reflect its coordinates with respect the direction of motion of the spacecraft.
checkForContent(String) - Static method in class hirondelle.starfield.util.Args
Throw an IllegalArgumentException if aText does not satisfy textHasContent(java.lang.String).
checkForEmpty(Collection) - Static method in class hirondelle.starfield.util.Args
Throw an IllegalArgumentException only if aCollection.isEmpty returns true.
checkForNull(Object) - Static method in class hirondelle.starfield.util.Args
If aObject is null, throw a NullPointerException.
checkForRange(int, int, int) - Static method in class hirondelle.starfield.util.Args
Throw an IllegalArgumentException if isInRange(int, int, int) returns false.
Chomper - Class in hirondelle.starfield.catalog.parser
Chop up a single line of a star catalog into the parts needed by this tool.
Chomper(String) - Constructor for class hirondelle.starfield.catalog.parser.Chomper
Constructor.
colorIndexToTemperature(double) - Static method in class hirondelle.starfield.physics.Star
Simple mapping of color index to a representative approximate temperature in Kelvin.
Consts - Class in hirondelle.starfield.util
Constants of general utility.
Coords - Class in hirondelle.starfield.projection
Struct to hold image pixel coords for a projected star location.
Coords() - Constructor for class hirondelle.starfield.projection.Coords
 
Coords(double, double) - Constructor for class hirondelle.starfield.projection.Coords
 
createImageIcon(String, String, Class) - Static method in class hirondelle.starfield.util.UiUtil
Create an icon for use by a given class.

D

Declination - Variable in class hirondelle.starfield.physics.Star
Declination of the star in radians.
DirectionOfMotion - Class in hirondelle.starfield.physics
Change the direction of motion of the spacecraft.
DirectionOfMotion(double, double, double) - Constructor for class hirondelle.starfield.physics.DirectionOfMotion
Constructor.
DirectionOfMotionTEST - Class in hirondelle.starfield.physics
 
DirectionOfMotionTEST(String) - Constructor for class hirondelle.starfield.physics.DirectionOfMotionTEST
 
dispose() - Method in class hirondelle.starfield.physics.StarfieldImage
Clean up resources when finished with this object.

E

EqualAreaCylindricalProjection - Class in hirondelle.starfield.projection
Whole sky projection with many variations, according to the value of the 'standard latitude'.
EqualAreaCylindricalProjection(double) - Constructor for class hirondelle.starfield.projection.EqualAreaCylindricalProjection
Constructor.
equalizeSizes(List<JComponent>) - Static method in class hirondelle.starfield.util.UiUtil
Sets the items in aComponents to the same size.
EquiRectangularProjection - Class in hirondelle.starfield.projection
Whole sky projection; mathematically, this one has the simplest implementation.
EquiRectangularProjection() - Constructor for class hirondelle.starfield.projection.EquiRectangularProjection
 
err(Object) - Static method in class hirondelle.starfield.util.Util
Log to stderr.
ExceptionHandler - Class in hirondelle.starfield.gui
Custom handler for any uncaught exceptions.
ExceptionHandler() - Constructor for class hirondelle.starfield.gui.ExceptionHandler
 

F

forDeclination(int, int, int, int, int, int, int) - Method in class hirondelle.starfield.catalog.parser.Chomper
Declination of a star in radians.
forDouble(int, int) - Method in class hirondelle.starfield.catalog.parser.Chomper
Number with a decimal portion.
forInt(int, int) - Method in class hirondelle.starfield.catalog.parser.Chomper
Simple integer, no decimal.
forMagnitude(int, int) - Method in class hirondelle.starfield.catalog.parser.Chomper
The magnitude of a star.
forRightAscension(int, int, int, int, int, int) - Method in class hirondelle.starfield.catalog.parser.Chomper
Right Ascension of a star in radians.
forText(int, int) - Method in class hirondelle.starfield.catalog.parser.Chomper
Chunk of text.
forText(int) - Method in class hirondelle.starfield.catalog.parser.Chomper
Text for a single byte at the given index.

G

generateFile() - Method in class hirondelle.starfield.physics.StarfieldImage
Notify this class that no more stars are to be added, and to generate the final file as output.
getActiveFrame() - Static method in class hirondelle.starfield.util.UiUtil
Return the currently active frame.
getBeta() - Method in class hirondelle.starfield.physics.InputParameters
 
getCatalog() - Method in class hirondelle.starfield.physics.InputParameters
 
getCatalogDirectory() - Method in class hirondelle.starfield.physics.InputParameters
 
getCommandColumn(List<JComponent>) - Static method in class hirondelle.starfield.util.UiUtil
Make a vertical row of buttons of equal size, whch are equally spaced, and aligned on the right.
getCommandRow(List<JComponent>) - Static method in class hirondelle.starfield.util.UiUtil
Make a horizontal row of buttons of equal size, whch are equally spaced, and aligned on the right.
getDialogTitle(String) - Static method in class hirondelle.starfield.util.UiUtil
Return text which conforms to the Look and Feel Design Guidelines for the title of a dialog : the application name, a colon, then the name of the specific dialog.
getDimensionFromPercent(int, int) - Static method in class hirondelle.starfield.util.UiUtil
Return a Dimension whose size is defined not in terms of pixels, but in terms of a given percent of the screen's width and height.
getDirectionOfMotionDec() - Method in class hirondelle.starfield.physics.InputParameters
 
getDirectionOfMotionRA() - Method in class hirondelle.starfield.physics.InputParameters
 
getErrors() - Method in exception hirondelle.starfield.physics.InputParameterException
Return all the error messages.
getImageSize() - Method in class hirondelle.starfield.physics.InputParameters
 
getInputParams() - Method in class hirondelle.starfield.physics.Starfield
 
getLimitingMagnitude() - Method in class hirondelle.starfield.physics.InputParameters
 
getMagnification() - Method in class hirondelle.starfield.physics.InputParameters
 
getOutputFile() - Method in class hirondelle.starfield.physics.InputParameters
 
getProjection() - Method in enum hirondelle.starfield.projection.Projector
Return the corresponding implementation of Projection.
getProjector() - Method in class hirondelle.starfield.physics.InputParameters
 
getRecordParser() - Method in enum hirondelle.starfield.catalog.parser.Catalog
Return the object which can parse a catalog record into the required data.
getRotation() - Method in class hirondelle.starfield.physics.InputParameters
 
getStandardBorder() - Static method in class hirondelle.starfield.util.UiUtil
Return a border of dimensions recommended by the Java Look and Feel Design Guidelines, suitable for many common cases.
getValue() - Method in enum hirondelle.starfield.util.UiUtil.AlignX
 
getValue() - Method in enum hirondelle.starfield.util.UiUtil.AlignY
 

H

HammerProjection - Class in hirondelle.starfield.projection
Whole sky projection, with boundary as a 2:1 ellipse.
HammerProjection() - Constructor for class hirondelle.starfield.projection.HammerProjection
 
hasError() - Method in exception hirondelle.starfield.physics.InputParameterException
Return true only if there's 1 or more errors.
HenryDraperCatalog - Class in hirondelle.starfield.catalog.parser
Parse a record from the Henry Draper Catalog.
HenryDraperCatalog() - Constructor for class hirondelle.starfield.catalog.parser.HenryDraperCatalog
 
hirondelle.starfield - package hirondelle.starfield
Launch point for the command line version of the application.
hirondelle.starfield.catalog.parser - package hirondelle.starfield.catalog.parser
Parse a single line of a catalog record into the data needed for the starfield calculation.
hirondelle.starfield.gui - package hirondelle.starfield.gui
Launch point for the graphical (GUI) version of the application.
hirondelle.starfield.physics - package hirondelle.starfield.physics
Core data and calculations.
hirondelle.starfield.projection - package hirondelle.starfield.projection
Various projections of the celestial sphere onto a plane.
hirondelle.starfield.util - package hirondelle.starfield.util
Minor utilities.

I

InputParameterException - Exception in hirondelle.starfield.physics
Checked exception thrown when an error in user input is detected.
InputParameterException() - Constructor for exception hirondelle.starfield.physics.InputParameterException
 
InputParameters - Class in hirondelle.starfield.physics
Model object for all items input by the user.
InputParameters(String, String, String, String, String, String, String, String, String, String, String) - Constructor for class hirondelle.starfield.physics.InputParameters
Construct using text only.
InputParametersTEST - Class in hirondelle.starfield.physics
 
InputParametersTEST(String) - Constructor for class hirondelle.starfield.physics.InputParametersTEST
 
isHalfSky() - Method in enum hirondelle.starfield.projection.Projector
Return true only if the projection will present a half-sky view, and not a whole-sky view.
isInRange(int, int, int) - Static method in class hirondelle.starfield.util.Util
Return true only if aNumber is in the range aLow..aHigh (inclusive).
isMissing(int, int) - Method in class hirondelle.starfield.catalog.parser.Chomper
Return true only if the given text has no content.
isNotDefault() - Method in class hirondelle.starfield.physics.DirectionOfMotion
Return true only if the user has input at least one parameter that differs from the default.

L

Launch - Class in hirondelle.starfield.gui
Launch point for the graphical (GUI) version of the application.
Launch() - Constructor for class hirondelle.starfield.gui.Launch
 
log(Object) - Static method in class hirondelle.starfield.util.Util
Log to stdout.
logVerbose(Object) - Static method in class hirondelle.starfield.util.Util
Print to stdout only if a System property named 'verbose' exists.

M

Magnitude - Variable in class hirondelle.starfield.physics.BoostedStar
The apparent magnitude of the star after the boost.
Magnitude - Variable in class hirondelle.starfield.physics.Star
The brightness of the star.
main(String...) - Static method in class hirondelle.starfield.gui.Launch
Run the graphical application.
Main - Class in hirondelle.starfield
Launch point for the tool.
Main() - Constructor for class hirondelle.starfield.Main
 
main(String...) - Static method in class hirondelle.starfield.Main
Run this application from the command line.
main(String[]) - Static method in class hirondelle.starfield.physics.BoostTEST
Run the test cases.
main(String[]) - Static method in class hirondelle.starfield.physics.DirectionOfMotionTEST
Run the test cases.
main(String[]) - Static method in class hirondelle.starfield.physics.InputParametersTEST
Run the test cases.
MckinleyProjection - Class in hirondelle.starfield.projection
Half-sky projection, equal areas.
MckinleyProjection() - Constructor for class hirondelle.starfield.projection.MckinleyProjection
 

N

NL - Static variable in class hirondelle.starfield.util.Consts
Newline separator.
NO_KEYSTROKE_MASK - Static variable in class hirondelle.starfield.util.UiConsts
Symbolic name for absence of keystroke mask.
noDefaultButton(JRootPane) - Static method in class hirondelle.starfield.util.UiUtil
Ensure that aRootPane has no default button associated with it.
NumRecordsRejected - Variable in class hirondelle.starfield.physics.StarfieldStats
Occasionally, some catalog records can't be used, for various reasons.
NumStarsInSimulation - Variable in class hirondelle.starfield.physics.StarfieldStats
The total number of stars extracted successfully from the star catalog, both above and below the limiting magnitude.
NumStarsVisible - Variable in class hirondelle.starfield.physics.StarfieldStats
Number of stars that are brighter than the limiting magnitude.

O

ONE_SPACE - Static variable in class hirondelle.starfield.util.UiConsts
 

P

parse(String) - Method in class hirondelle.starfield.catalog.parser.HenryDraperCatalog
See class comment.
parse(String) - Method in interface hirondelle.starfield.catalog.parser.RecordParser
Parse a single line from a star catalog into the parts needed for the starfield calculation.
parse(String) - Method in class hirondelle.starfield.catalog.parser.TestParser
See class comment.
parse(String) - Method in class hirondelle.starfield.catalog.parser.Tycho2Catalog
See class comment.
parse(String) - Method in class hirondelle.starfield.catalog.parser.YaleBrightStarCatalog
See class comment.
project(double, double, double, Coords) - Method in class hirondelle.starfield.projection.BehrmannProjection
 
project(double, double, double, Coords) - Method in class hirondelle.starfield.projection.MckinleyProjection
 
project(double, double, double, Coords) - Method in interface hirondelle.starfield.projection.Projection
Return the coordinates of the star, ready for rendering on an image context.
project(double, double, double, Coords) - Method in class hirondelle.starfield.projection.StereoscopicProjection
 
project(double, double, double, Coords) - Method in class hirondelle.starfield.projection.WholeSkyProjection
 
Projection - Interface in hirondelle.starfield.projection
Project a star's location on the celestial sphere onto the plane of an image.
Projector - Enum in hirondelle.starfield.projection
Enumeration to indicate the desired Projection to be used in making the starfield image.
projectWithLatLong(double, double, double, Coords) - Method in class hirondelle.starfield.projection.EqualAreaCylindricalProjection
 
projectWithLatLong(double, double, double, Coords) - Method in class hirondelle.starfield.projection.EquiRectangularProjection
See class comment.
projectWithLatLong(double, double, double, Coords) - Method in class hirondelle.starfield.projection.HammerProjection
 
projectWithLatLong(double, double, double, Coords) - Method in class hirondelle.starfield.projection.WholeSkyProjection
Use a projection formula expressed in latitude and longitude.

Q

quote(String) - Static method in class hirondelle.starfield.util.Util
Put the given text in single quotes.

R

radians(double) - Static method in class hirondelle.starfield.util.Util
Convert degrees to radians.
RecordParser - Interface in hirondelle.starfield.catalog.parser
Create a Star object from a single record in a star catalog. Assumes that a single line in the file corresponds to a single star.
RightAscension - Variable in class hirondelle.starfield.physics.Star
Right Ascension of the star in radians.

S

Screen - Class in hirondelle.starfield.gui
Screen containing the graphical interface for this application.
Screen() - Constructor for class hirondelle.starfield.gui.Screen
 
SIMPLE_FIELD_WIDTH - Static variable in class hirondelle.starfield.util.UiConsts
Suggested width for a JTextField
spectralTypeToTemperature(String) - Static method in class hirondelle.starfield.physics.Star
Simple mapping of the first letter of a star's spectral type to a representative approximate temperature in Kelvin.
STANDARD_BORDER - Static variable in class hirondelle.starfield.util.UiConsts
 
Star - Class in hirondelle.starfield.physics
Struct to carry the data related to a star, plus conversion methods.
Star() - Constructor for class hirondelle.starfield.physics.Star
 
Starfield - Class in hirondelle.starfield.physics
Perform the desired calculation and generate an image.
Starfield(InputParameters) - Constructor for class hirondelle.starfield.physics.Starfield
Constructor.
StarfieldImage - Class in hirondelle.starfield.physics
Dynamically generate an image of a starfield to an output image file, one star at a time.
StarfieldImage(Projector, File, int, int) - Constructor for class hirondelle.starfield.physics.StarfieldImage
Constructor.
StarfieldStats - Class in hirondelle.starfield.physics
Struct for high-level statistics regarding the starfield.
StarfieldStats() - Constructor for class hirondelle.starfield.physics.StarfieldStats
 
StereoscopicProjection - Class in hirondelle.starfield.projection
Half-sky projection, preserves small circles on the celestial sphere.
StereoscopicProjection() - Constructor for class hirondelle.starfield.projection.StereoscopicProjection
 

T

Temperature - Variable in class hirondelle.starfield.physics.BoostedStar
The apparent blackbody surface temperature of the star, after the boost.
Temperature - Variable in class hirondelle.starfield.physics.Star
The black-body surface temperature of the star in Kelvin.
temperatureToColor(double) - Static method in class hirondelle.starfield.physics.Star
Map a star's black body surface temperature in Kelvin to a corresponding color.
testAberration() - Method in class hirondelle.starfield.physics.BoostTEST
 
testConstructorFail() - Method in class hirondelle.starfield.physics.InputParametersTEST
 
testConstructorSucceed() - Method in class hirondelle.starfield.physics.InputParametersTEST
 
testDoppler() - Method in class hirondelle.starfield.physics.BoostTEST
 
testIsDefault() - Method in class hirondelle.starfield.physics.DirectionOfMotionTEST
 
testIsNotDefault() - Method in class hirondelle.starfield.physics.DirectionOfMotionTEST
 
testMagnitude() - Method in class hirondelle.starfield.physics.BoostTEST
 
TestParser - Class in hirondelle.starfield.catalog.parser
Parse an artificial test record.
TestParser() - Constructor for class hirondelle.starfield.catalog.parser.TestParser
 
textHasContent(String) - Static method in class hirondelle.starfield.util.Util
Return true only if aText is not null, and if its raw String is not empty after trimming.
ThetaPrime - Variable in class hirondelle.starfield.physics.BoostedStar
The angle from direction of motion, after the boost.
THREE_SPACES - Static variable in class hirondelle.starfield.util.UiConsts
 
toString() - Method in class hirondelle.starfield.physics.BoostedStar
For debugging only.
toString() - Method in class hirondelle.starfield.physics.InputParameters
Intended For debugging.
toString() - Method in class hirondelle.starfield.physics.Star
For debugging only.
toString() - Method in class hirondelle.starfield.physics.StarfieldStats
Return the basic stats as a single string.
toString() - Method in class hirondelle.starfield.projection.Coords
Intended for debugging.
TWO_SPACES - Static variable in class hirondelle.starfield.util.UiConsts
 
Tycho2Catalog - Class in hirondelle.starfield.catalog.parser
Parse a record from the Tycho 2 Catalog.
Tycho2Catalog() - Constructor for class hirondelle.starfield.catalog.parser.Tycho2Catalog
 

U

UiConsts - Class in hirondelle.starfield.util
Collected constants related to the user interface.
UiUtil - Class in hirondelle.starfield.util
Static convenience methods for GUIs which eliminate code duplication.
UiUtil() - Constructor for class hirondelle.starfield.util.UiUtil
 
UiUtil.AlignX - Enum in hirondelle.starfield.util
Enumeration for horizontal alignment.
UiUtil.AlignY - Enum in hirondelle.starfield.util
Type-safe enumeration vertical alignment.
uncaughtException(Thread, Throwable) - Method in class hirondelle.starfield.gui.ExceptionHandler
Custom handler for uncaught exceptions.
Util - Class in hirondelle.starfield.util
Utility methods.

V

valueOf(String) - Static method in enum hirondelle.starfield.catalog.parser.Catalog
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum hirondelle.starfield.projection.Projector
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum hirondelle.starfield.util.UiUtil.AlignX
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum hirondelle.starfield.util.UiUtil.AlignY
Returns the enum constant of this type with the specified name.
values() - Static method in enum hirondelle.starfield.catalog.parser.Catalog
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum hirondelle.starfield.projection.Projector
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum hirondelle.starfield.util.UiUtil.AlignX
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum hirondelle.starfield.util.UiUtil.AlignY
Returns an array containing the constants of this enum type, in the order they are declared.

W

WholeSkyProjection - Class in hirondelle.starfield.projection
Template base class for whole-sky projections.
WholeSkyProjection() - Constructor for class hirondelle.starfield.projection.WholeSkyProjection
 

X

X - Variable in class hirondelle.starfield.physics.BoostedStar
Coordinate for rendering the star on an image.
X - Variable in class hirondelle.starfield.projection.Coords
 

Y

Y - Variable in class hirondelle.starfield.physics.BoostedStar
Coordinate for rendering the star on an image.
Y - Variable in class hirondelle.starfield.projection.Coords
 
YaleBrightStarCatalog - Class in hirondelle.starfield.catalog.parser
Parse a record from the Yale Bright Star Catalog.
YaleBrightStarCatalog() - Constructor for class hirondelle.starfield.catalog.parser.YaleBrightStarCatalog
 
A B C D E F G H I L M N O P Q R S T U V W X Y 
Relativistic Starfield 1.0.0

Starfield - Copyright Hirondelle Systems. Published March 1, 2014