Brad Cavanagh > Astro-Flux > Astro::FluxColor

Download:
Astro-Flux-0.01.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.01   Source  

NAME ^

Astro::FluxColor - Class for handling astronomical color quantities.

SYNOPSIS ^

use Astro::FluxColor;

  $color = new Astro::FluxColor( lower => $lower_waveband,
                                 upper => $upper_waveband,
                                 quantity => $quantity,
                                 datetime => new DateTime );

  $quantity = $color->quantity;

DESCRIPTION ^

Class for handling astronomical color quantities.

METHODS ^

Constructor

new

Create a new instance of an Astro::FluxColor object.

$color = new Astro::FluxColor( lower => $lower_waveband, upper => $upper_waveband, quantity => $quantity, datetime => new DateTime );

The three named parameters are mandatory. lower and upper denote the lower and upper wavebands for the colour, and must be Astro::WaveBand objects. quantity is a numerical value in magnitudes.

Accessor Methods

quantity

Returns the actual color value.

  my $value = $color->quantity;

There are no parameters.

error

Returns the actual uncertainty in the cerror.

  my $e = $color->error;

There are no parameters.

lower

Returns the lower waveband.

  my $lower = $color->lower;

There are no parameters. An Astro::WaveBand object is returned.

upper

Returns the upper waveband.

  my $upper = $color->upper;

There are no parameters. An Astro::WaveBand object is returned.

datetime

Returns the datetime stamp for the given flux object.

  my $datetime = $flux->datetime;

Returns an Date::datetime object if defined. If not, returns undef.

REVISION ^

  $Id: FluxColor.pm,v 1.6 2005/06/15 01:14:01 allan Exp $

AUTHORS ^

Brad Cavanagh <b.cavanagh@jach.hawaii.edu>, Alasdair Allan <aa@astro.ex.ac.uk>

COPYRIGHT ^

Copyright (C) 2004 Particle Physics and Astronomy Research Council. All Rights Reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: