GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  ASTRO::FLUXCOLOR (3)

.ds Aq ’

NAME

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

CONTENTS

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

<B>newB> 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

<B>quantityB> Returns the actual color value.



  my $value = $color->quantity;



There are no parameters.

<B>errorB> Returns the actual uncertainty in the cerror.



  my $e = $color->error;



There are no parameters.

<B>lowerB> Returns the lower waveband.



  my $lower = $color->lower;



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

<B>upperB> Returns the upper waveband.



  my $upper = $color->upper;



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

<B>datetimeB> 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.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 FLUXCOLOR (3) 2005-06-15

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.