diff --git a/documentation/site/apireference.html b/documentation/site/apireference.html index 9854a9b..6fc55bf 100644 --- a/documentation/site/apireference.html +++ b/documentation/site/apireference.html @@ -170,7 +170,7 @@
Initialisation of parent irgsc class . This class has several child classes.
+Initialisation of child irgsc class . This class has several child classes.
This method described using input ra and dec. It checks whther the data from PANSTARRS DR2, UKISS DR11 and Gaia DR3 can be obtained.
@@ -298,7 +298,49 @@read_gaia_data()
Reads the input GAIA DR3 data. The number of columns are 12.
+ `irgsctool.ReadData.read_gaia_data()`
+
+This method reads the input GAIA DR3 data. The number of columns are 12. The format of the input file if the +data is obtained externally is 'GAIA' + '_' + 'RA'+str(ra) + 'DEC' + str(dec)+'.csv'
+RAISES | +DESCRIPTION | +
---|---|
+
+ValueError
+
+ |
+
+ This error is raised when there are no observations in Gaia database. + |
+
RETURNS | +DESCRIPTION | +
---|---|
+gaia_data
+ |
+
+ A multi-dimensional array of gaia sourced_id, astrometry, +and ruwe. + |
+
read_nir_data()
Reads the input UKIDSS NIR data. The number of columns are 8.
-Returns the input optical data with nan values removed (if present) -and restricts the data to the sources having SNR >= 5.
-Some regions do not have J or H band data especially DXS or GCS -surveys. For these regions, only K band data is imported.
+ `irgsctool.ReadData.read_nir_data()`
+
+Reads the input UKIDSS NIR data. The number of columns are 8. +Some regions do not have J or H band data especially DXS or GCS +surveys. For these regions, only K band data is obtained. This method filters the data +for nan values and selects the sources that have SNR>5 and plots the histogram of the NIR magnitudes available. +The format of the input file if the +data is obtained externally is 'UKIDSS'+'_'+'RA'+str(ra)+'DEC'+ str(dec)+'.csv' +Raises: + ValueError: This error is raised when there are no observations available in UKIDSS database.
+RETURNS | +DESCRIPTION | +
---|---|
+nir_data
+ |
+
+ A multi-dimensional data of observed UKIDSS NIR sources +that have SNR>5. Also plots a histogram of UKIDSS data. + |
+
RETURNS | +DESCRIPTION | +
---|---|
+filtered_optical_data
+ |
+
+ A multi-dimensional array consisting of optical panstarrs + stack photometry in five bands which is free from nan values and duplicate sources. + |
+
irgsctool.StarGalaxyClassification.star_galaxy_classification()
This method is used to seperate stars and galaxies using -the condition applied to all the five optical filters:
+$$ (psf-kron) < 0.05 $$
@@ -392,10 +479,30 @@PANSTARRS data containing most probable stellar sources
+A multi-dimensional array of the PANSTARRS optical data containing
+ + +most probable stellar sources after seperating the galaxies. Also plots
+the figures showing the comparison of $$i_{psf}$$ vs ($$i_{psf}$$ - $$i_{kron}$$),
+the color-color diagrams of the stars and galaxies.
irgsctool.ExtinctionCorrection.extinction_correctdd_photometry()
`irgsctool.ExtinctionCorrection.extinction_corrected_photometry()`
+
+This method corrects the input optical PANSTARRS data for reddening -and extinction along the line of site.
-RETURNS | -DESCRIPTION | -
---|---|
-ndarray
- |
-
- Extinction corrected PANSTARRS optical photometry. - |
-
Returns: + psf_phot: A multi-dimensional array consisting of extinction + corrected PANSTARRS optical photometry containing psf and kron + measurements.
irgsctool.ExtinctionCorrection.get_reddening()
This method obtains the reddening value for a given set of +
RETURNS | +DESCRIPTION | +
---|---|
+sam_params
+ |
+
+ A multi-dimwnsional array of the sam parameters +depending upon the model selected. + |
+
RETURNS | +RAISES | DESCRIPTION |
---|---|---|
-sam_params
- |
-
- type: ndarray: Selected model parameters and model - |
-|
+
+TypreError
+
|
-
- magnitudes to generate IRGSC + |
+ if range of parameters is not given. |
RAISES | +RETURNS | DESCRIPTION |
---|---|---|
-
-TypreError
-
+sam_params
|
-
- if range of parameters is not given. + |
+ A multi-dimwnsional array of the selected model parameters and model + |
+
+ | +
+ magnitudes to generate IRGSC. |
- The generated IRGSC. +A multi-dimensional array consisting of the generated IRGSC. |
@@ -782,6 +897,24 @@
RETURNS | +DESCRIPTION | +
---|---|
+irgsc_data
+ |
+
+ A multi-dimensional array consisting of elements in IRGSC. + |
+