AstroToolkit 1.1.5__tar.gz → 1.1.7__tar.gz

{AstroToolkit-1.1.5/src/AstroToolkit.egg-info → AstroToolkit-1.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: AstroToolkit
-Version: 1.1.5
+Version: 1.1.7
 Summary: A package for the gathering and plotting of astronomical data.
 Author-email: Ethan Moorfield <ethan.moorfield@hotmail.co.uk>
 Project-URL: Homepage, https://github.com/WD-planets/AstroToolkit
@@ -988,12 +988,12 @@ returns: list of 'pos' objects, i.e. a list of lists with each 'pos' = [ra,dec].
 
 ### 6. getsd
 
+Gets a spatial distribution plot of all objects in a .fits file.
+
 ```
 getsd(file_name)
 ```
 
-Gets a spatial distribution plot of all objects in a .fits file.
-
 where:
 ```
 file_name = string
@@ -1004,18 +1004,112 @@ returns: bokeh plot or None (if no data retrieved).
 
 ### 7. convertsource
 
+Converts a gaia source_id to a JHHMMSS.SS+DDMMSS.SS identifier (as seen in the save_data file naming convention).
+
 ```
 convertsource(source)
 ```
 
-Converts a gaia source_id to a JHHMMSS.SS+DDMMSS.SS identifier (as seen in the save_data file naming convention).
-
 where:
 ```
 source = integer/string
        = Gaia source_id (e.g. 6050296829033196032).
 ```
 
+### 8. readlocal
+
+Reads a local csv-esque file (ie. columns separated by a separator, rows separated by a newline) into a 2D list containing the column data. A complete file name is not needed, the search will pick up any file whos name contains the input Gaia source_id or position in the format: ra_dec (i.e. the same format used throughout the toolkit for saving data).
+
+```
+readlocal(source=None,pos=None,extension='csv',headers=True,separator=',',getfilename=False):
+```
+
+where:
+
+```
+source      = integer/string
+            = Gaia source_id (e.g. 6050296829033196032).
+```
+```
+pos         = 1D tuple of two integers
+            = [ra,dec], object coordinates in degrees.
+```
+```
+extension   = string
+            = file extension (without the '.')
+```
+```
+headers     = boolean
+	    = tells the tool whether to ignore the first row of data (if being used as column headers)
+```
+```
+separator   = str
+	    = tells the tool what separator to expect between columns
+```
+```
+getfilename = boolean
+	    = tells the tool whether to also return the name of the file it found
+```
+
+### 9. plotdata
+
+A significantly simplified plotting function  for making quick Bokeh plots. 
+
+***Note:*** This function is only intended to make the quick creation of basic Bokeh plots easier. For fully customizable Bokeh plots, refer to the Bokeh documentation.
+
+```
+plotdata(x,y,x_err=None,y_err=None,title=None,xlabel=None,ylabel=None,xtype='linear',ytype='linear',marker='circle',colour='black',legend='Data Points')
+```
+
+where:
+
+```
+x      = tuple
+       = coordinates of data points on x-axis
+```
+```
+y      = tuple
+       = coordinates of data points on y axis
+```
+```
+x_err  = tuple
+       = x errors on data points (in same order as x)
+```
+```
+y_err  = tuple
+       = y errors on data points (in same order as x)
+```
+```
+title  = string
+       = plot title
+```
+```
+xlabel = string
+       = x-axis label
+```
+```
+ylabel = string
+       = y-axis label
+```
+```
+xtype  = string, 'linear' or 'log'
+       = x-axis type
+```
+```
+ytype  = string, 'linear' or 'log'
+       = y-axis type
+```
+```
+marker = string, 'circle' or 'line'
+       = type of plot (circle = scatter, line = line)
+```
+```
+colour = colour of markers/lines/error bars
+```
+```
+legend = name to give the data points in the legend
+```
+
 ## Datapage functions
 
 These functions are used to create custom datapages from any plots/data supported by AstroToolkit.

{AstroToolkit-1.1.5 → AstroToolkit-1.1.7}/README.md

@@ -960,12 +960,12 @@ returns: list of 'pos' objects, i.e. a list of lists with each 'pos' = [ra,dec].
 
 ### 6. getsd
 
+Gets a spatial distribution plot of all objects in a .fits file.
+
 ```
 getsd(file_name)
 ```
 
-Gets a spatial distribution plot of all objects in a .fits file.
-
 where:
 ```
 file_name = string
@@ -976,18 +976,112 @@ returns: bokeh plot or None (if no data retrieved).
 
 ### 7. convertsource
 
+Converts a gaia source_id to a JHHMMSS.SS+DDMMSS.SS identifier (as seen in the save_data file naming convention).
+
 ```
 convertsource(source)
 ```
 
-Converts a gaia source_id to a JHHMMSS.SS+DDMMSS.SS identifier (as seen in the save_data file naming convention).
-
 where:
 ```
 source = integer/string
        = Gaia source_id (e.g. 6050296829033196032).
 ```
 
+### 8. readlocal
+
+Reads a local csv-esque file (ie. columns separated by a separator, rows separated by a newline) into a 2D list containing the column data. A complete file name is not needed, the search will pick up any file whos name contains the input Gaia source_id or position in the format: ra_dec (i.e. the same format used throughout the toolkit for saving data).
+
+```
+readlocal(source=None,pos=None,extension='csv',headers=True,separator=',',getfilename=False):
+```
+
+where:
+
+```
+source      = integer/string
+            = Gaia source_id (e.g. 6050296829033196032).
+```
+```
+pos         = 1D tuple of two integers
+            = [ra,dec], object coordinates in degrees.
+```
+```
+extension   = string
+            = file extension (without the '.')
+```
+```
+headers     = boolean
+	    = tells the tool whether to ignore the first row of data (if being used as column headers)
+```
+```
+separator   = str
+	    = tells the tool what separator to expect between columns
+```
+```
+getfilename = boolean
+	    = tells the tool whether to also return the name of the file it found
+```
+
+### 9. plotdata
+
+A significantly simplified plotting function  for making quick Bokeh plots. 
+
+***Note:*** This function is only intended to make the quick creation of basic Bokeh plots easier. For fully customizable Bokeh plots, refer to the Bokeh documentation.
+
+```
+plotdata(x,y,x_err=None,y_err=None,title=None,xlabel=None,ylabel=None,xtype='linear',ytype='linear',marker='circle',colour='black',legend='Data Points')
+```
+
+where:
+
+```
+x      = tuple
+       = coordinates of data points on x-axis
+```
+```
+y      = tuple
+       = coordinates of data points on y axis
+```
+```
+x_err  = tuple
+       = x errors on data points (in same order as x)
+```
+```
+y_err  = tuple
+       = y errors on data points (in same order as x)
+```
+```
+title  = string
+       = plot title
+```
+```
+xlabel = string
+       = x-axis label
+```
+```
+ylabel = string
+       = y-axis label
+```
+```
+xtype  = string, 'linear' or 'log'
+       = x-axis type
+```
+```
+ytype  = string, 'linear' or 'log'
+       = y-axis type
+```
+```
+marker = string, 'circle' or 'line'
+       = type of plot (circle = scatter, line = line)
+```
+```
+colour = colour of markers/lines/error bars
+```
+```
+legend = name to give the data points in the legend
+```
+
 ## Datapage functions
 
 These functions are used to create custom datapages from any plots/data supported by AstroToolkit.

{AstroToolkit-1.1.5 → AstroToolkit-1.1.7}/pyproject.toml

@@ -7,7 +7,7 @@ include-package-data = true
 
 [project]
 name = "AstroToolkit"
-version = "1.1.5"
+version = "1.1.7"
 authors = [
   { name="Ethan Moorfield", email="ethan.moorfield@hotmail.co.uk"},
 ]

{AstroToolkit-1.1.5 → AstroToolkit-1.1.7}/src/AstroToolkit/Figures/HRD.py

@@ -12,7 +12,11 @@ from ..Surveys.Gaia import GaiaQuerySource
 
 fits_file = files('AstroToolkit.Figures').joinpath('backdrop_hrd_allmags.fits')
 
+'''
+Creates the HRD plot with a source/sources as an overlay
+'''
 def get_plot(source=None,sources=None):
+	# reads the background file ('backdrop_hrd_allmags.fits') into separate datasets based on their object classifications.
 	background=Table.read(fits_file).to_pandas()
 	background_100pc=background.loc[background['type']==b'100pc']
 	background_wd=background.loc[background['type']==b'WD']
@@ -20,12 +24,14 @@ def get_plot(source=None,sources=None):
 	background_wd_dm=background.loc[background['type']==b'WD+dM']
 	background_sd=background.loc[background['type']==b'SD']
 	
+	# combines these into a split dataset
 	background_split=[background_100pc,background_wd,background_wd_dm,background_cv,background_sd]
 	
 	x_arr=[]
 	y_arr=[]
 	colour_arr=[]
 	
+	# calculates x (bp-rp) and y (abs g) positions of all objects in the background sample
 	for sample in background_split:
 		x=sample['phot_bp_mean_mag'].values-sample['phot_rp_mean_mag'].values
 		y=sample['phot_g_mean_mag'].values+5*np.log10(sample['parallax'].values/1000)+5
@@ -33,27 +39,36 @@ def get_plot(source=None,sources=None):
 		x_arr.append(x)
 		y_arr.append(y)
 	
+	# Sets the colour maps used by each category of object
 	colour_maps=['Greens','Purples','Reds','Blues','YlOrBr']
 	
+	# Removes extreme ends of colour maps for visibility (i.e. strips colours that are too light)
 	for i in range(0,len(colour_maps)):
 		colour_maps[i]=cmr.get_sub_cmap(colour_maps[i],0.4,1.0)
 
+	# Creates the effect of darker colours in higher density regions of each category
 	for i in range(0,len(x_arr)):
+		#stacks x and y values to calculate a gaussian density and then uses this to normalise across the colour map based on density of nearby data points
 		values=np.vstack([x_arr[i],y_arr[i]])
 		kernel=stats.gaussian_kde(values)
 		weights=kernel(values)
 		weights=weights/weights.max()
 		
+		# uses a hex representation of RGB colour values to create the final colour maps weighted for each object based on nearby point density
 		colour=["#%02x%02x%02x" % (int(r), int(g), int(b)) for r, g, b, _ in 255*colour_maps[i](weights)]
 		colour_arr.append(colour)
 
+	# Create plot
 	plot=figure(width=400,height=400,title='Gaia HRD',x_axis_label=r'\[\text{bp-rp}\]',y_axis_label=r'\[\text{abs g}\]')
 	plot.y_range.flipped = True
 
+	# sets labels for legend
 	labels=['100pc','WDs','CVs','WD+dM','SDs']
+	# places background points with their colours set, and addstheir respective category to the legend
 	for i in range(0,len(x_arr)):
 		plot.scatter(x_arr[i],y_arr[i],size=3,color=colour_arr[i],legend_label=labels[i])
 
+	# overlays source on top of background sample as long as all the necessary data is available
 	if source!=None:
 		data=GaiaQuerySource(source=source)
 		gmag,bpmag,rpmag,parallax=data['phot_g_mean_mag'].values,data['phot_bp_mean_mag'].values,data['phot_rp_mean_mag'].values,data['parallax'].values
@@ -64,7 +79,8 @@ def get_plot(source=None,sources=None):
 			plot.scatter(x=x,y=y,marker='square_dot',line_color='black',fill_color=None,size=20,line_width=2,legend_label='Source')
 		else:
 			return None
-
+	
+	# same as above but handles multiple sources
 	elif sources!=None:
 		for i in range(0,len(sources)):
 			data=GaiaQuerySource(source=sources[i])

{AstroToolkit-1.1.5 → AstroToolkit-1.1.7}/src/AstroToolkit/Figures/SD.py

@@ -1,15 +1,13 @@
 from AstroToolkit.Tools import getpositions
-from bokeh.plotting import figure,show
+from bokeh.plotting import figure
 
+# gets list of positions from .fits file
 def get_plot(file_name):
     pos_list=getpositions(file_name)
   
+    # creates spatial distribution plot
     plot=figure(width=400,height=400,title='Spatial Distribution',x_axis_label='ra [deg]',y_axis_label='dec [deg]')
     for i in range(0,len(pos_list)):
         plot.circle(x=pos_list[i][0],y=pos_list[i][1],color='black',legend_label='Sources')
 
-    return plot    
-
-if __name__=='__main__':
-    fig=getSD(file_name='pre-ztf.fits')
-    show(fig)
+    return plot

{AstroToolkit-1.1.5 → AstroToolkit-1.1.7}/src/AstroToolkit/Figures/SED.py

@@ -1,3 +1,4 @@
+from ssl import cert_time_to_seconds
 import astropy.units as u
 import math
 import pandas as pd
@@ -16,6 +17,7 @@ from ..Surveys.GALEX import GALEXGetPhotometryCoords
 from ..Surveys.PanSTARRS import PanSTARRSGetPhotometryCoords
 from ..Surveys.SkyMapper import SkyMapperGetPhotometryCoords
 
+# used to calculate fluxes using zero point, mag and wavelength of filter
 def zeropoint(mag,zp,wl):
 	flux=zp*10**(-0.4*mag)
 	c=2.988*10**18
@@ -24,9 +26,7 @@ def zeropoint(mag,zp,wl):
 	return flux
 
 def get_plot(source=None,pos=None,radius=3,save_data=False):
-	if source!=None and pos!=None:
-		raise Exception('simulatenous source and pos input detected')
-	
+	# proper motion corrects positions for use in each supported survey
 	if source!=None:
 		gaia_data=GaiaQuerySource(source=source)
 		ra,dec,pmra,pmdec=gaia_data['ra'].values[0],gaia_data['dec'].values[0],gaia_data['pmra'].values[0],gaia_data['pmdec'].values[0]
@@ -63,9 +63,6 @@ def get_plot(source=None,pos=None,radius=3,save_data=False):
 		ra_sdss,dec_sdss=pos[0],pos[1]
 		ra_wise,dec_wise=pos[0],pos[1]
 		ra_twomass,dec_twomass=pos[0],pos[1]
-		
-	else:
-		raise Exception('either source or pos input required')
 	
 	filter_arr=[]
 	
@@ -74,39 +71,60 @@ def get_plot(source=None,pos=None,radius=3,save_data=False):
 	flux_arr=[]
 	mag_arr=[]
 	
+	'''
+	wavelength_arr = list of lists with wavelengths of each filter in a survey, i.e. [[gaia_g,gaia_r,gaia_i],[galex_nuv,galex_fuv] ... etc.]
+	flux = same as above but with the corresponding fluxes
+	error_arr = same as above but with the corresponding flux errors
+	mag_arr = same as above but with the object's magnitudes through these filters, used to calculate the fluxes
+	
+	The functionality is the same for each survey, so I probably need to try and parameterise this at some point
+	'''
+
 	wavelengths=[]
 	flux=[]
 	errors=[]
 	mags=[]
+	# Get survey photometry
 	photometry=GaiaGetPhotometryCoords(ra_gaia,dec_gaia,radius=radius)
 	if isinstance(photometry,pd.DataFrame):
+		# names of filters and errors in survey
 		filter_list=['phot_g_mean_mag','phot_rp_mean_mag','phot_bp_mean_mag']
 		error_list=['phot_g_mean_mag_error','phot_rp_mean_mag_error','phot_bp_mean_mag_error']
+		# zero points of filters
 		zero_points=[2.5e-9,1.24e-9,4.11e-9]
 
 		#g,rp,bp
 		filter_ref=[5850.88,7690.74,5041.61]
 		
+		# iterates through filter_list,error_list,zero_points simultaneously
 		for filter, error, zp in zip(filter_list,error_list,zero_points):
 			try:
+				# gets magnitude value in current filter
 				mag=photometry._get_value(0,filter)
 				mags.append(mag)
 
+				# gets error value for this magnitude
 				errors.append((photometry._get_value(0,error)*u.ABmag))
+				# gets the wavelength of the current filter
 				wavelength=(filter_ref[filter_list.index(filter)])
 				wavelengths.append(wavelength)
 
+				# calculates the flux using the current filter's zero point
 				fl=zeropoint(mag=mag,zp=zp,wl=wavelength)
 				flux.append(fl)
 
+				# appends the filter's name to filter_arr if this was all successful
 				filter_arr.append(filter)
 			except:
 				pass
+	
+	# Appends the obtained values to the data arrays (see above)
 	wavelength_arr.append(wavelengths)
 	flux_arr.append(flux)
 	error_arr.append(errors)
 	mag_arr.append(mags)
 
+	# These are only temporary arrays used in each survey, so here they get over-written. The functionality is then the same for all future surveys, except filter zero points are calculated manually.
 	wavelengths=[]
 	flux=[]
 	errors=[]
@@ -127,7 +145,8 @@ def get_plot(source=None,pos=None,radius=3,save_data=False):
 				errors.append((photometry._get_value(0,error)*u.ABmag))
 				wavelength=(filter_ref[filter_list.index(filter)])
 				wavelengths.append(wavelength)
-					
+				
+				# calculate zero point of current filter manually
 				zp=10**((5*np.log10(filter_ref[filter_list.index(filter)])+2.406)/-2.5)
 				fl=zeropoint(mag=mag,zp=zp,wl=wavelength)
 				flux.append(fl)
@@ -305,6 +324,7 @@ def get_plot(source=None,pos=None,radius=3,save_data=False):
 	error_arr.append(errors)
 	mag_arr.append(mags)
 
+	# strip all data of its units if it has any
 	for i in range(0,len(flux_arr)):
 		for j in range(0,len(flux_arr[i])):
 			try:
@@ -315,6 +335,7 @@ def get_plot(source=None,pos=None,radius=3,save_data=False):
 		for j in range(0,len(error_arr[i])):
 			error_arr[i][j]=error_arr[i][j].value
 
+	# calculate an array of relative errors from error values (cannot directly calculate errors using error propagation due to quirks of magnitude system (i.e. logarithmic and decreasing >> brighter))
 	rel_error_arr=[]
 	for i in range(0,len(mag_arr)):	
 		flux_arr[i]=np.asarray(flux_arr[i])
@@ -323,6 +344,7 @@ def get_plot(source=None,pos=None,radius=3,save_data=False):
 
 		rel_error_arr.append(flux_arr[i]*error_arr[i]/mag_arr[i])
 
+	# if no data, return None
 	if len(wavelength_arr)==0 and len(flux_arr)==0:
 		if save_data==True:
 			return None, None
@@ -333,14 +355,16 @@ def get_plot(source=None,pos=None,radius=3,save_data=False):
 	#Order in script: Gaia, GALEX, PanSTARRS, SkyMapper, SDSS, WISE, 2MASS
 	colour_arr=['springgreen','royalblue','gold','aquamarine','deepskyblue','orangered','orange']
 	
+	# Create figure object
 	plot=figure(width=400,height=400,title='SED',x_axis_label=r'\[\lambda_{\text{eff}}\text{ }[\text{AA}]\]',y_axis_label=r'\[\text{flux [mJy]}\]',x_axis_type='log',y_axis_type="log")	
 
-	# Bokeh only understands np nan values
+	# Bokeh only understands np nan values, so convert math.nan to np.nan
 	for i in range(0,len(wavelength_arr)):
 		wavelength_arr[i]=[np.nan if math.isnan(x) else x for x in wavelength_arr[i]]
 		flux_arr[i]=[np.nan if math.isnan(x) else x for x in flux_arr[i]]
 		rel_error_arr[i]=[np.nan if math.isnan(x) else x for x in rel_error_arr[i]]
-
+	
+	# create data sources used to create plots
 	sources=[]
 	for i in range(0,len(wavelength_arr)):
 		upper=[x+e for x,e in zip(flux_arr[i],rel_error_arr[i])]
@@ -351,14 +375,19 @@ def get_plot(source=None,pos=None,radius=3,save_data=False):
 
 	surveys=['Gaia','GALEX','PanSTARRS','SkyMapper','SDSS','WISE','2MASS']
 
+	# plot data points
 	for i in range(0,len(wavelength_arr)):
 		if len(flux_arr[i])>0:
 			plot.circle(x='wavelength',y='flux',source=sources[i],color=colour_arr[i],legend_label=f'{surveys[i]}')
+			# add errors (has to be handled separately in bokeh :/ )
 			errors=Whisker(source=sources[i],base='wavelength',upper='upper',lower='lower',line_width=0.5,line_color=colour_arr[i])
 			errors.upper_head.line_width,errors.lower_head.line_width=0.5,0.5
 			errors.upper_head.size,errors.lower_head.size=3,3
 			errors.upper_head.line_color,errors.lower_head.line_color=colour_arr[i],colour_arr[i]
-	
+			plot.add_layout(errors)
+			
+	# if saving data, flatten arrays to 1d (i.e. you lose information about which survey each point is obtained from, not ideal but cannot seem to write to .csv with different sized dataframes unless 
+    # completely separating the data as with getbulkphot() etc, which is then going to annoying to handle. Can improve.
 	if save_data==True:
 		flat_flux=[]
 		flat_wavelength=[]

{AstroToolkit-1.1.5 → AstroToolkit-1.1.7}/src/AstroToolkit/Miscellaneous/ProperMotionCorrection.py

@@ -1,7 +1,11 @@
+from calendar import c
 import math
 
+'''
+Takes an input year in format [year,month] and corrects coordinates of an object (using its pmra and pmdec) to correct for its proper motion to a target year in format [year,month]
+'''
 def PMCorrection(input,target,inputObjRA,inputObjDEC,pmRA,pmDEC,radius=None):
-	#Filter inputs
+	# Filter inputs
 	if not isinstance(input[0],int):
 		raise Exception('input year must be an integer')
 	if not isinstance(input[1],int):
@@ -16,16 +20,19 @@ def PMCorrection(input,target,inputObjRA,inputObjDEC,pmRA,pmDEC,radius=None):
 			inputObjRA=float(inputObjRA)
 		except:
 			raise Exception('object RA must be a float or an integer')
+		
 	if not isinstance(inputObjDEC,float):
 		try:
 			inputObjDEC=float(inputObjDEC)
 		except:
 			raise Exception('object DEC must be a float or an integer')
+		
 	if not isinstance(pmRA,float):
 		try:
 			pmRA=float(pmRA)
 		except:
 			raise Exception('object PM_RA must be a float or an integer')
+		
 	if not isinstance(pmDEC,float):
 		try:
 			pmDEC=float(pmDEC)
@@ -35,14 +42,18 @@ def PMCorrection(input,target,inputObjRA,inputObjDEC,pmRA,pmDEC,radius=None):
 	inputYear,inputMonth=input[0],input[1]
 	targetYear,targetMonth=target[0],target[1]
 	
+	# get change in years and change in months
 	yearDelta=targetYear-inputYear
 	monthDelta=targetMonth-inputMonth
 
+	# correct for proper motion
 	inputObjRA+=(yearDelta*pmRA/3600000+monthDelta*pmRA/43200000)*1/math.cos(inputObjDEC/360*2*math.pi)
 	inputObjDEC+=yearDelta*pmDEC/3600000+monthDelta*pmDEC/43200000
 	
+	# get time delta in years
 	timeDelta=abs(yearDelta+monthDelta/12)
 	
+	# if a radius is given, use this time delta to scale the radius (used in adaptive proper motion correction)
 	if radius!=None:
 		radius=radius+math.sqrt((pmRA/1000)**2+(pmDEC/1000)**2)*timeDelta
 		return inputObjRA,inputObjDEC,radius

{AstroToolkit-1.1.5 → AstroToolkit-1.1.7}/src/AstroToolkit/Miscellaneous/ReadFits.py

@@ -1,14 +1,19 @@
 from astropy.table import Table
 
+'''
+gets a list of sources from a fits file
+'''
 def get_source_list(file_name):
     if not file_name.endswith('.fits'):
         file_name+='.fits'
-
+       
+    # read file into a pandas dataframe 
     try:
         data=Table.read(file_name).to_pandas()
     except:
         raise Exception(f'File: {file_name} not found, or invalid format.')
     
+    # get source_id column
     try:
         sources=data.loc[:,'source_id'].tolist()
     except:
@@ -20,16 +25,20 @@ def get_pos_list(file_name):
     if not file_name.endswith('.fits'):
         file_name+='.fits'
 
+    # read file into pandas dataframe
     try:
         data=Table.read(file_name).to_pandas()
     except:
         raise Exception(f'File: {file_name} not found, or invalid format.')
     
+    # get ra and dec columns
     try:
         ra=data.loc[:,'ra'].tolist()
         dec=data.loc[:,'dec'].tolist()
     except:
         raise Exception('ra/dec columns not found.')
     
+    # zips ra and dec values into pos ([ra,dec]) as supported by the rest of the toolkit
     pos_list=[list(x) for x in zip(ra,dec)]
+    
     return pos_list

{AstroToolkit-1.1.5 → AstroToolkit-1.1.7}/src/AstroToolkit/Overlays/Overlay_GALEX.py

@@ -6,6 +6,18 @@ from ..Surveys.Gaia import GaiaQueryCoords
 from ..Surveys.GALEX import GALEXQueryCoords
 from ..Miscellaneous.ProperMotionCorrection import PMCorrection
 
+'''
+Functionality is essentially the same in all overlay functions, so refer to Overlay_Gaia for further comments
+'''
+
+'''
+Functionality of all overlays other than Gaia follows this process:
+1. Get Gaia detections for proper motions
+2. Proper motion correct these Gaia detections back to the time of any other overlay (e.g. GALEX)
+3. do a radius search around this new corrected gaia location and see if it picks up any detections in the selected overlays
+4. use proper motions obtained from Gaia to correct these and any picked up detections to the image time
+'''
+
 #Creates Galex overlay
 def getGalexOverlayNUV(plot,ra,dec,sizeAS,mjd,border,pmra,pmdec):
 	#checks if GALEX search was successful