Loading csst_proto/flip_image.py +23 −7 Original line number Diff line number Diff line import numpy as np from astropy import table from . import PACKAGE_PATH # the main algorithm def flip_image(img: np.ndarray) -> np.ndarray: """ flip an input image """ Flip an input image. This function uses an awesome algorithm to flip an input image. Parameters ---------- img: the input image img : np.ndarray The input image. Returns ------- img_flipped: np.ndarray the flipped image np.ndarray The flipped image. Examples -------- >>> flip_image(np.array([1, 2], [3, 4])) """ try: assert img.ndim == 2 Loading @@ -30,7 +33,20 @@ def flip_image(img: np.ndarray) -> np.ndarray: # a demo on how to read test image def read_test_image(): """ read test image """ """ Read test image. This function reads the test image associated with this package. Returns ------- np.ndarray The test image. Examples -------- >>> test_image = read_test_image() """ fp_img = PACKAGE_PATH + "/data/test_image.txt" print("reading file {} ...".format(fp_img)) return np.loadtxt(fp_img, dtype=int) csst_proto/some_other_modules.py +14 −1 Original line number Diff line number Diff line def a_demo_function(*args): """ a demo function """ """ A demo function. This function is a demo. Parameters ---------- *args : any The argument list. Examples -------- >>> a_demo_function(None) """ return None Loading
csst_proto/flip_image.py +23 −7 Original line number Diff line number Diff line import numpy as np from astropy import table from . import PACKAGE_PATH # the main algorithm def flip_image(img: np.ndarray) -> np.ndarray: """ flip an input image """ Flip an input image. This function uses an awesome algorithm to flip an input image. Parameters ---------- img: the input image img : np.ndarray The input image. Returns ------- img_flipped: np.ndarray the flipped image np.ndarray The flipped image. Examples -------- >>> flip_image(np.array([1, 2], [3, 4])) """ try: assert img.ndim == 2 Loading @@ -30,7 +33,20 @@ def flip_image(img: np.ndarray) -> np.ndarray: # a demo on how to read test image def read_test_image(): """ read test image """ """ Read test image. This function reads the test image associated with this package. Returns ------- np.ndarray The test image. Examples -------- >>> test_image = read_test_image() """ fp_img = PACKAGE_PATH + "/data/test_image.txt" print("reading file {} ...".format(fp_img)) return np.loadtxt(fp_img, dtype=int)
csst_proto/some_other_modules.py +14 −1 Original line number Diff line number Diff line def a_demo_function(*args): """ a demo function """ """ A demo function. This function is a demo. Parameters ---------- *args : any The argument list. Examples -------- >>> a_demo_function(None) """ return None
