Skip to content

Commit

Permalink
Minor documentation changes
Browse files Browse the repository at this point in the history
  • Loading branch information
AarynnCarter committed Dec 11, 2023
1 parent 6c89911 commit e754d1b
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions spaceKLIP/analysistools.py
Original file line number Diff line number Diff line change
Expand Up @@ -727,8 +727,6 @@ def calibrate_contrast(self,
fontsize=11)
plt.savefig(save_string + '_calcon.pdf',
bbox_inches='tight', dpi=300)

pass

def extract_companions(self,
companions,
Expand Down Expand Up @@ -1509,7 +1507,6 @@ def inject_and_recover(raw_dataset,
raw_dataset : pyKLIP dataset
A pyKLIP dataset which companions will be injected into and KLIP
will be performed on.
true_companions :
injection_psf : 2D-array
The PSF of the companion to be injected.
injection_seps : 1D-array
Expand All @@ -1536,8 +1533,18 @@ def inject_and_recover(raw_dataset,
Returns
-------
TBD
all_seps : np.array
Array containing the separations of all injected
companions across all images.
all_pas : np.array
Array containing the position angles of all injected
companions across all images.
all_inj_fluxes : np.array
Array containing the injected peak fluxes of all injected
companions across all images.
all_retr_fluxes : np.array
Array containing the retrieved peak fluxes of all injected
companions across all images.
'''

# Initialise some arrays and quantities
Expand Down

0 comments on commit e754d1b

Please sign in to comment.