Module: sarpyx.utils.grid
File: sarpyx/utils/grid.py
No module docstring available; module purpose is inferred from implementation.
Exported Symbols (__all__)
No explicit __all__ list. Public symbols inferred from implementation.
Public Functions (1)
get_utm_zone_from_latlng function
Get the UTM zone from a latlng list and return the corresponding EPSG code.
File location: sarpyx/utils/grid.py:207
Signature
get_utm_zone_from_latlng(latlng)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
latlng | inferred from implementation | yes | - | List[Union[int, float]] The latlng list to get the UTM zone from. |
Return Type
inferred from implementation
str The EPSG code for the UTM zone.
Exceptions
ValueError
Side Effects
- io
Example Usage
from sarpyx.utils.grid import get_utm_zone_from_latlng
result = get_utm_zone_from_latlng(latlng=<latlng>)Edge Cases
May raise: ValueError.
Public Classes (1)
Grid class
inferred from implementation.
File location: sarpyx/utils/grid.py:12
Class Signature
class GridConstructor Parameters
Return Type
Grid instances.
Exceptions
Construction/runtime exceptions are inferred from implementation and method-level documentation.
Side Effects
See method-level side effects below.
Example Usage
from sarpyx.utils.grid import Grid
obj = Grid(...) # inferred from implementation
Edge Cases
No class-level edge-case section is explicitly documented; rely on method-level checks and raised exceptions.
Public Methods (9)
Grid.get_rows method
inferred from implementation.
File location: sarpyx/utils/grid.py:24
Signature
get_rows(self)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
- | - | no | - | No explicit public parameters; behavior inferred from implementation. |
Return Type
inferred from implementation
inferred from implementation.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.utils.grid import Grid
# Constructor arguments are inferred from implementation.
obj = Grid(...) # inferred from implementation
result = obj.get_rows()Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
Grid.get_circumference_at_latitude method
inferred from implementation.
File location: sarpyx/utils/grid.py:50
Signature
get_circumference_at_latitude(self, lat)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
lat | inferred from implementation | yes | - | inferred from implementation. |
Return Type
inferred from implementation
inferred from implementation.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.utils.grid import Grid
# Constructor arguments are inferred from implementation.
obj = Grid(...) # inferred from implementation
result = obj.get_circumference_at_latitude(lat=<lat>)Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
Grid.subdivide_circumference method
inferred from implementation.
File location: sarpyx/utils/grid.py:59
Signature
subdivide_circumference(self, lat, return_cols=False)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
lat | inferred from implementation | yes | - | inferred from implementation. |
return_cols | inferred from implementation | no | False | inferred from implementation. |
Return Type
inferred from implementation
inferred from implementation.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.utils.grid import Grid
# Constructor arguments are inferred from implementation.
obj = Grid(...) # inferred from implementation
result = obj.subdivide_circumference(lat=<lat>)Edge Cases
Includes optional parameters with implementation-defined fallback behavior.
Grid.get_points method
inferred from implementation.
File location: sarpyx/utils/grid.py:79
Signature
get_points(self)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
- | - | no | - | No explicit public parameters; behavior inferred from implementation. |
Return Type
inferred from implementation
inferred from implementation.
Exceptions
ValueError
Side Effects
- inferred from implementation
Example Usage
from sarpyx.utils.grid import Grid
# Constructor arguments are inferred from implementation.
obj = Grid(...) # inferred from implementation
result = obj.get_points()Edge Cases
May raise: ValueError.
Grid.group_points_by_row method
inferred from implementation.
File location: sarpyx/utils/grid.py:122
Signature
group_points_by_row(self)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
- | - | no | - | No explicit public parameters; behavior inferred from implementation. |
Return Type
inferred from implementation
inferred from implementation.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.utils.grid import Grid
# Constructor arguments are inferred from implementation.
obj = Grid(...) # inferred from implementation
result = obj.group_points_by_row()Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
Grid.filter_longitude method
inferred from implementation.
File location: sarpyx/utils/grid.py:129
Signature
filter_longitude(self, cols, lons)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cols | inferred from implementation | yes | - | inferred from implementation. |
lons | inferred from implementation | yes | - | inferred from implementation. |
Return Type
inferred from implementation
inferred from implementation.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.utils.grid import Grid
# Constructor arguments are inferred from implementation.
obj = Grid(...) # inferred from implementation
result = obj.filter_longitude(cols=<cols>, lons=<lons>)Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
Grid.latlon2rowcol method
Convert latitude and longitude to row and column number from the grid
File location: sarpyx/utils/grid.py:134
Signature
latlon2rowcol(self, lats, lons, return_idx=False, integer=False)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
lats | inferred from implementation | yes | - | inferred from implementation. |
lons | inferred from implementation | yes | - | inferred from implementation. |
return_idx | inferred from implementation | no | False | inferred from implementation. |
integer | inferred from implementation | no | False | inferred from implementation. |
Return Type
inferred from implementation
inferred from implementation.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.utils.grid import Grid
# Constructor arguments are inferred from implementation.
obj = Grid(...) # inferred from implementation
result = obj.latlon2rowcol(lats=<lats>, lons=<lons>)Edge Cases
Includes optional parameters with implementation-defined fallback behavior.
Grid.rowcol2latlon method
inferred from implementation.
File location: sarpyx/utils/grid.py:161
Signature
rowcol2latlon(self, rows, cols)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
rows | inferred from implementation | yes | - | inferred from implementation. |
cols | inferred from implementation | yes | - | inferred from implementation. |
Return Type
inferred from implementation
inferred from implementation.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.utils.grid import Grid
# Constructor arguments are inferred from implementation.
obj = Grid(...) # inferred from implementation
result = obj.rowcol2latlon(rows=<rows>, cols=<cols>)Edge Cases
No explicit edge-case section found; behavior is inferred from implementation.
Grid.get_bounded_footprint method
inferred from implementation.
File location: sarpyx/utils/grid.py:167
Signature
get_bounded_footprint(self, point, buffer_ratio=0)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
point | inferred from implementation | yes | - | inferred from implementation. |
buffer_ratio | inferred from implementation | no | 0 | inferred from implementation. |
Return Type
inferred from implementation
inferred from implementation.
Exceptions
None explicitly documented; inferred from implementation.
Side Effects
- inferred from implementation
Example Usage
from sarpyx.utils.grid import Grid
# Constructor arguments are inferred from implementation.
obj = Grid(...) # inferred from implementation
result = obj.get_bounded_footprint(point=<point>)Edge Cases
Includes optional parameters with implementation-defined fallback behavior.