Expect that column values as geometry points to be contained within a bounding circle with a given radius (or diameter).
expect_column_minimum_bounding_radius_to_be_between
This expectation level is BETA
Description
Expect that column values as geometry points to be contained within a bounding circle with a given radius (or diameter).
expect_column_values_minimum_bounding_radius_to_be_between is a :func:`column_expectation <great_expectations.dataset.dataset.MetaDataset.column_expectation>`.
Args:
column (str): The column name.
Column values must be provided in WKT or WKB format, which are commom formats for GIS Database formats.
WKT can be accessed thhrough the ST_AsText() or ST_AsBinary() functions in queries for PostGIS and MSSQL.
Column values can alternately be given in x,y tuple or list pairs.
The user is responsible for the coordinate reference system and the units. e.g. values may be given in easting-northing pairs.
min_value (float or None): The minimum radius (or diameter) that bounds all geometries in the column
max_value (float or None): The maximum radius (or diameter) that bounds all geometries in the column
strict_min (boolean): If True, the minimal radius must be strictly larger than min_value,
Default: False
strict_max (boolean): If True, the maximal radius must be strictly smaller than max_value,
Default: False
Keyword Args:
column_shape_format: str
Geometry format for 'column' (wkt, wkb, xy). Column values can be provided in WKT or WKB format, which are commom formats for GIS Database formats.
xy also supports tuple pairs or list pairs for points only
WKT can be accessed thhrough the ST_AsText() or ST_AsBinary() functions in queries for PostGIS and MSSQL.
Must be one of: [wkt, wkb, xy]
Default: wkt
diameter_flag (boolean): If True, the user can specify a diameter as opposed to a radius,
Default: False
Returns:
An ExpectationSuiteValidationResult
Notes:
These fields in the result object are customized for this expectation:
::
{
"observed_value": (list) The actual bounding radius (or diameter)
}
* min_value and max_value are both inclusive unless strict_min or strict_max are set to True.
* If min_value is None, then max_value is treated as an upper bound
* If max_value is None, then min_value is treated as a lower bound
Want to make your own Expectation or an improvement to this one?
We've put together some great how to guides (including videos) on how to create your own expectations in a flash!
You can see those resources here: Contributor Resources