cartodb4/observatory-extension
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #55 from CartoDB/iss52-metaissue-updates

Browse Source 
Iss52 metaissue updates
This commit is contained in:
Andy Eschbacher 2016-05-11 08:43:41 -04:00
commit 94b1ad4a71
5 changed files with 138 additions and 112 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

182
doc/methods.md
View File

@ -14,7 +14,9 @@ Name |Description
--- | --- --- | ---
point_geometry | a WGS84 point geometry (the_geom) point_geometry | a WGS84 point geometry (the_geom)
measure_name | a human readable string name of a US Census variable. The glossary of measure_names is [available below]('measure_name table'). measure_name | a human readable string name of a US Census variable. The glossary of measure_names is [available below]('measure_name table').
normalize | for measures that are are **sums** (e.g. population) the default normalization is 'area' and response comes back as a rate per square kilometer. Other options are 'denominator', which will use the denominator specified in the normalize | for measures that are are **sums** (e.g., population) the default normalization is 'area' and response comes back as a rate per square kilometer. Other options are 'denominator', which will use the denominator specified in the [Data Catalog](http://cartodb.github.io/bigmetadata/index.html) (optional)
boundary_id | source of geometries to pull measure from (e.g., 'us.census.tiger.census_tract')
time_span | time span of interest (e.g., 2010 - 2014)
#### Returns #### Returns
@ -29,7 +31,8 @@ value | the raw or normalized measure
Add a Measure to an empty column based on point locations in your table Add a Measure to an empty column based on point locations in your table
```SQL ```SQL
UPDATE tablename SET local_male_population = OBS_GetUSCensusMeasure(the_geom, 'Male Population') UPDATE tablename
SET local_male_population = OBS_GetUSCensusMeasure(the_geom, 'Male Population')
``` ```
Get a measure at a single point location Get a measure at a single point location
@ -54,6 +57,8 @@ Name |Description
point_geometry | a WGS84 polygon geometry (the_geom) point_geometry | a WGS84 polygon geometry (the_geom)
measure_name | a human readable string name of a US Census variable. The glossary of measure_names is [available below]('measure_name table'). measure_name | a human readable string name of a US Census variable. The glossary of measure_names is [available below]('measure_name table').
normalize | for measures that are are **sums** (e.g. population) the default normalization is 'none' and response comes back as a raw value. Other options are 'denominator', which will use the denominator specified in the [Data Catalog](http://cartodb.github.io/bigmetadata/index.html) (optional) normalize | for measures that are are **sums** (e.g. population) the default normalization is 'none' and response comes back as a raw value. Other options are 'denominator', which will use the denominator specified in the [Data Catalog](http://cartodb.github.io/bigmetadata/index.html) (optional)
boundary_id | source of geometries to pull measure from (e.g., 'us.census.tiger.census_tract')
time_span | time span of interest (e.g., 2010 - 2014)
#### Returns #### Returns
@ -68,13 +73,18 @@ value | the raw or normalized measure
Add a Measure to an empty column based on polygons in your table Add a Measure to an empty column based on polygons in your table
```SQL ```SQL
UPDATE tablename SET local_male_population = OBS_GetUSCensusMeasure(the_geom, 'Male Population') UPDATE tablename
SET local_male_population = OBS_GetUSCensusMeasure(the_geom, 'Male Population')
``` ```
Get a measure at a single polygon Get a measure at a single polygon
```SQL ```SQL
SELECT OBS_GetMeasure(ST_Buffer(CDB_LatLng(40.7, -73.9),0.001), 'Male Population') SELECT OBS_GetMeasure(
ST_Buffer(
CDB_LatLng(40.7, -73.9)::geography,
1000)::geometry,
'Male Population')
``` ```
<!-- <!--
@ -92,20 +102,24 @@ Name |Description
--- | --- --- | ---
point_geometry | a WGS84 point geometry (the_geom) point_geometry | a WGS84 point geometry (the_geom)
measure_name | a human readable string name of a US Census variable. The glossary of measure_names is [available below]('measure_name table'). measure_name | a human readable string name of a US Census variable. The glossary of measure_names is [available below]('measure_name table').
boundary_id | source of geometries to pull measure from (e.g., 'us.census.tiger.census_tract')
time_span | time span of interest (e.g., 2010 - 2014)
#### Returns #### Returns
A NUMERIC value containing the following properties A TEXT value containing the following properties
Key | Description Key | Description
--- | --- --- | ---
value | the raw or normalized measure value | description of the segment at the location of the input geometry
#### Example #### Example
Add a Measure to an empty column based on point locations in your table Add a Measure to an empty column based on point locations in your table
```SQL ```SQL
UPDATE tablename SET local_male_population = OBS_GetUSCensusCategory(the_geom, 'Spielman Singleton Category 10') UPDATE tablename
SET local_male_population = OBS_GetUSCensusCategory(the_geom, 'Spielman Singleton Category 10')
``` ```
Get a measure at a single point location Get a measure at a single point location
@ -129,6 +143,8 @@ Name |Description
point_geometry | a WGS84 point geometry (the_geom) point_geometry | a WGS84 point geometry (the_geom)
measure_id | a measure identifier from the Data Observatory ([see available measures](http://cartodb.github.io/bigmetadata/index.html)) measure_id | a measure identifier from the Data Observatory ([see available measures](http://cartodb.github.io/bigmetadata/index.html))
normalize | for measures that are are **sums** (e.g. population) the default normalization is 'area' and response comes back as a rate per square kilometer. Other options are 'denominator', which will use the denominator specified in the [Data Catalog](http://cartodb.github.io/bigmetadata/index.html) and 'none' which will return a raw value. (optional) normalize | for measures that are are **sums** (e.g. population) the default normalization is 'area' and response comes back as a rate per square kilometer. Other options are 'denominator', which will use the denominator specified in the [Data Catalog](http://cartodb.github.io/bigmetadata/index.html) and 'none' which will return a raw value. (optional)
boundary_id | source of geometries to pull measure from (e.g., 'us.census.tiger.census_tract')
time_span | time span of interest (e.g., 2010 - 2014)
#### Returns #### Returns
@ -143,13 +159,16 @@ value | the raw or normalized measure
Add a Measure to an empty column based on point locations in your table Add a Measure to an empty column based on point locations in your table
```SQL ```SQL
UPDATE tablename SET local_male_population = OBS_GetMeasure(the_geom, '"us.census.acs".B08134006') UPDATE tablename
SET local_male_population = OBS_GetMeasure(the_geom, 'us.census.acs.B08134006')
``` ```
Get a measure at a single point location Get a measure at a single point location
```SQL ```SQL
SELECT OBS_GetMeasure(CDB_LatLng(40.7, -73.9), '"us.census.acs".B08134006') SELECT OBS_GetMeasure(
CDB_LatLng(40.7, -73.9),
'us.census.acs.B08134006')
``` ```
<!-- <!--
@ -168,6 +187,8 @@ Name |Description
polygon_geometry | a WGS84 polygon geometry (the_geom) polygon_geometry | a WGS84 polygon geometry (the_geom)
measure_id | a measure identifier from the Data Observatory ([see available measures](http://cartodb.github.io/bigmetadata/index.html)) measure_id | a measure identifier from the Data Observatory ([see available measures](http://cartodb.github.io/bigmetadata/index.html))
normalize | for measures that are are **sums** (e.g. population) the default normalization is 'none' and response comes back as a raw value. Other options are 'denominator', which will use the denominator specified in the [Data Catalog](http://cartodb.github.io/bigmetadata/index.html) (optional) normalize | for measures that are are **sums** (e.g. population) the default normalization is 'none' and response comes back as a raw value. Other options are 'denominator', which will use the denominator specified in the [Data Catalog](http://cartodb.github.io/bigmetadata/index.html) (optional)
boundary_id | source of geometries to pull measure from (e.g., 'us.census.tiger.census_tract')
time_span | time span of interest (e.g., 2010 - 2014)
#### Returns #### Returns
@ -182,15 +203,18 @@ value | the raw or normalized measure
Add a Measure to an empty column based on polygons in your table Add a Measure to an empty column based on polygons in your table
```SQL ```SQL
UPDATE tablename SET local_male_population = OBS_GetMeasure(the_geom, '"us.census.acs".B08134006') UPDATE tablename
SET local_male_population = OBS_GetMeasure(the_geom, 'us.census.acs.B08134006')
``` ```
Get a measure within a polygon Get a measure within a polygon
```SQL ```SQL
SELECT OBS_GetMeasure(ST_Buffer(CDB_LatLng(40.7, -73.9),0.001), '"us.census.acs".B08134006') SELECT OBS_GetMeasure(
ST_Buffer(
CDB_LatLng(40.7, -73.9)::geography,
1000)::geometry,
'us.census.acs.B08134006')
``` ```
<!-- <!--
@ -226,7 +250,7 @@ Overwrite a point geometry with a boundary geometry that contains it in your tab
```SQL ```SQL
UPDATE tablename UPDATE tablename
SET the_geom = OBS_GetBoundary(the_geom, '"us.census.tiger".block_group') SET the_geom = OBS_GetBoundary(the_geom, 'us.census.tiger.block_group')
``` ```
<!-- <!--
@ -257,7 +281,7 @@ Write the geometry_id that contains the point geometry for every row as a new co
```SQL ```SQL
UPDATE tablename UPDATE tablename
SET new_column_name = OBS_GetBoundaryId(the_geom, ' "us.census.tiger".block_group') SET boundary_id = OBS_GetBoundaryId(the_geom, ' us.census.tiger.block_group')
``` ```
## OBS_GetBoundaryById(geometry_id, boundary_id) ## OBS_GetBoundaryById(geometry_id, boundary_id)
@ -274,7 +298,7 @@ timespan (optional) | year(s) to request from (`NULL` (default) gives most recen
#### Returns #### Returns
A JSON object containing the following properties A table containing the following properties
Key | Description Key | Description
--- | --- --- | ---
@ -285,7 +309,10 @@ geom | a WGS84 polygon geometry
Use a table of geometry_id to select the unique boundaries. Useful with the ```Create Dataset from Query``` option in CartoDB. Use a table of geometry_id to select the unique boundaries. Useful with the ```Create Dataset from Query``` option in CartoDB.
```SQL ```SQL
SELECT OBS_GetBoundaryById(geometry_id) As the_geom, geometry_id SELECT
OBS_GetBoundaryById(geometry_id, 'us.census.tiger.county') As the_geom,
geometry_id,
count(*)
FROM tablename FROM tablename
GROUP BY geometry_id GROUP BY geometry_id
``` ```
@ -314,15 +341,16 @@ geom_ref | a string identifier for the geometry (e.g., the geoid of a US Census
#### Example #### Example
Get all Census Tracts in Lower Manhattan (geoids beginning with `36061`) without getting Brooklyn or New Jersey Get all Census Block Groups in Lower Manhattan (geoids beginning with `36061`) without getting Brooklyn or New Jersey into an existing table with a geometry column `the_geom` and text column `geoid`.
```sql ```sql
SELECT * INSERT INTO lowermanhattan_census_tracts(the_geom, geoid)
SELECT the_geom, geom_ref
FROM OBS_GetBoundariesByGeometry( FROM OBS_GetBoundariesByGeometry(
ST_MakeEnvelope(-74.0251922607,40.6945658517, ST_MakeEnvelope(-74.0251922607,40.6945658517,
-73.9651107788,40.7377626342, -73.9651107788,40.7377626342,
4326), 4326),
'"us.census.tiger".census_tract') 'us.census.tiger.block_group')
WHERE geom_ref like '36061%' WHERE geom_ref like '36061%'
``` ```
@ -334,50 +362,6 @@ Retrieve all Census tracts contained in a bounding box around Denver, CO as a JS
http://observatory.cartodb.com/api/v2/sql?q=SELECT%20*%20FROM%20OBS_GetBoundariesByGeometry(ST_MakeEnvelope(-105.4287704158,39.4600507935,-104.5089737248,40.0901569675,4326),%27%22us.census.tiger%22.census_tract%27,%272009%27,%27contains%27) http://observatory.cartodb.com/api/v2/sql?q=SELECT%20*%20FROM%20OBS_GetBoundariesByGeometry(ST_MakeEnvelope(-105.4287704158,39.4600507935,-104.5089737248,40.0901569675,4326),%27%22us.census.tiger%22.census_tract%27,%272009%27,%27contains%27)
``` ```
## OBS_GetPointsByGeometry(geometry, geometry_id)
The ```OBS_GetPointsByGeometry(geometry, geometry_id)``` method returns point geometries and their geographical identifiers that intersect (or are contained by) a bounding box polygon and lie on the surface of a boundary corresponding to the boundary with same geographical identifiers (e.g., a point that is on a census tract with the same geoid).
#### Arguments
Name |Description
--- | ---
geometry | a bounding box
geometry_id | a string identifier for a boundary geometry
timespan (optional) | year(s) to request from (`NULL` (default) gives most recent)
overlap_type (optional) | one of 'intersects' (default), 'contains', or 'within'. See [ST_Intersects](http://postgis.net/docs/manual-2.2/ST_Intersects.html), [ST_Contains](http://postgis.net/docs/manual-2.2/ST_Contains.html), or [ST_Within](http://postgis.net/docs/manual-2.2/ST_Within.html) for more
#### Returns
A table with the following columns:
Column Name | Description
--- | ---
the_geom | a point geometry on a boundary (e.g., a point that lies on a US Census tract)
geom_ref | a string identifier for the geometry (e.g., the geoid of a US Census tract)
#### Example
Get points in all Census Tracts in Lower Manhattan (geoids beginning with `36061`) without getting Brooklyn or New Jersey
```sql
SELECT *
FROM OBS_GetPointsByGeometry(
ST_MakeEnvelope(-74.0251922607,40.6945658517,
-73.9651107788,40.7377626342,
4326),
'"us.census.tiger".census_tract')
WHERE geom_ref like '36061%'
```
#### API Example
Retrieve all Census tracts contained in a bounding box around Denver, CO as a JSON response:
```text
http://observatory.cartodb.com/api/v2/sql?q=SELECT%20*%20FROM%20OBS_GetPointsByGeometry(ST_MakeEnvelope(-105.4287704158,39.4600507935,-104.5089737248,40.0901569675,4326),%27%22us.census.tiger%22.census_tract%27,%272009%27,%27contains%27)
```
## OBS_GetBoundariesByPointAndRadius(geometry, radius, boundary_id) ## OBS_GetBoundariesByPointAndRadius(geometry, radius, boundary_id)
The ```OBS_GetBoundariesByPointAndRadius(geometry, radius, boundary_id)``` method returns boundary geometries and their geographical identifiers that intersect (or are contained by) a circle centered on a point with a radius. The ```OBS_GetBoundariesByPointAndRadius(geometry, radius, boundary_id)``` method returns boundary geometries and their geographical identifiers that intersect (or are contained by) a circle centered on a point with a radius.
@ -410,7 +394,7 @@ SELECT *
FROM OBS_GetBoundariesByPointAndRadius( FROM OBS_GetBoundariesByPointAndRadius(
CDB_LatLng(39.7392, -104.9903), -- Denver, Colorado CDB_LatLng(39.7392, -104.9903), -- Denver, Colorado
10000 * 1.609, -- 10 miles (10km * conversion to miles) 10000 * 1.609, -- 10 miles (10km * conversion to miles)
'"us.census.tiger".census_tract') 'us.census.tiger.census_tract')
``` ```
#### API Example #### API Example
@ -421,6 +405,50 @@ Retrieve all Census tracts contained in a bounding box around Denver, CO as a JS
http://observatory.cartodb.com/api/v2/sql?q=SELECT%20*%20FROM%20OBS_GetBoundariesByPointAndRadius(CDB_LatLng(39.7392,-104.9903),10000*1609),%27%22us.census.tiger%22.census_tract%27,%272009%27,%27contains%27) http://observatory.cartodb.com/api/v2/sql?q=SELECT%20*%20FROM%20OBS_GetBoundariesByPointAndRadius(CDB_LatLng(39.7392,-104.9903),10000*1609),%27%22us.census.tiger%22.census_tract%27,%272009%27,%27contains%27)
``` ```
## OBS_GetPointsByGeometry(geometry, geometry_id)
The ```OBS_GetPointsByGeometry(geometry, geometry_id)``` method returns point geometries and their geographical identifiers that intersect (or are contained by) a bounding box polygon and lie on the surface of a boundary corresponding to the boundary with same geographical identifiers (e.g., a point that is on a census tract with the same geoid).
#### Arguments
Name |Description
--- | ---
geometry | a bounding box
geometry_id | a string identifier for a boundary geometry
timespan (optional) | year(s) to request from (`NULL` (default) gives most recent)
overlap_type (optional) | one of 'intersects' (default), 'contains', or 'within'. See [ST_Intersects](http://postgis.net/docs/manual-2.2/ST_Intersects.html), [ST_Contains](http://postgis.net/docs/manual-2.2/ST_Contains.html), or [ST_Within](http://postgis.net/docs/manual-2.2/ST_Within.html) for more
#### Returns
A table with the following columns:
Column Name | Description
--- | ---
the_geom | a point geometry on a boundary (e.g., a point that lies on a US Census tract)
geom_ref | a string identifier for the geometry (e.g., the geoid of a US Census tract)
#### Example
Get points in all Census Tracts in Lower Manhattan (geoids beginning with `36061`) without getting Brooklyn or New Jersey
```sql
SELECT *
FROM OBS_GetPointsByGeometry(
ST_MakeEnvelope(-74.0251922607,40.6945658517,
-73.9651107788,40.7377626342,
4326),
'us.census.tiger.census_tract')
WHERE geom_ref like '36061%'
```
#### API Example
Retrieve all Census tracts contained in a bounding box around Denver, CO as a JSON response:
```text
http://observatory.cartodb.com/api/v2/sql?q=SELECT%20*%20FROM%20OBS_GetPointsByGeometry(ST_MakeEnvelope(-105.4287704158,39.4600507935,-104.5089737248,40.0901569675,4326),%27%22us.census.tiger%22.census_tract%27,%272009%27,%27contains%27)
```
## OBS_GetPointsByPointAndRadius(geometry, radius, boundary_id) ## OBS_GetPointsByPointAndRadius(geometry, radius, boundary_id)
The ```OBS_GetPointsByPointAndRadius(geometry, radius, boundary_id)``` method returns point geometries on boundaries (e.g., a point that lies on a Census tract) and their geographical identifiers that intersect (or are contained by) a circle centered on a point with a radius. The ```OBS_GetPointsByPointAndRadius(geometry, radius, boundary_id)``` method returns point geometries on boundaries (e.g., a point that lies on a Census tract) and their geographical identifiers that intersect (or are contained by) a circle centered on a point with a radius.
@ -453,7 +481,7 @@ SELECT *
FROM OBS_GetPointsByPointAndRadius( FROM OBS_GetPointsByPointAndRadius(
CDB_LatLng(39.7392, -104.9903), -- Denver, Colorado CDB_LatLng(39.7392, -104.9903), -- Denver, Colorado
10000 * 1.609, -- 10 miles (10km * conversion to miles) 10000 * 1.609, -- 10 miles (10km * conversion to miles)
'"us.census.tiger".census_tract') 'us.census.tiger.census_tract')
``` ```
#### API Example #### API Example
@ -523,17 +551,17 @@ SELECT * FROM OBS_GetAvailableBoundaries(CDB_LatLng(40.7, -73.9))
Boundary name | Boundary ID Boundary name | Boundary ID
--------------------- | --- --------------------- | ---
US Census Block Groups | "us.census.tiger".block_group US Census Block Groups | us.census.tiger.block_group
US Census Tracts | "us.census.tiger".census_tract US Census Tracts | us.census.tiger.census_tract
US States | "us.census.tiger".state US States | us.census.tiger.state
US County | "us.census.tiger".county US County | us.census.tiger.county
US Census Public Use Microdata Areas | "us.census.tiger".puma US Census Public Use Microdata Areas | us.census.tiger.puma
US Census Zip Code Tabulation Areas | "us.census.tiger".zcta5 US Census Zip Code Tabulation Areas | us.census.tiger.zcta5
Unified School District | "us.census.tiger".school_district_unified Unified School District | us.census.tiger.school_district_unified
US Congressional Districts | "us.census.tiger".congressional_district US Congressional Districts | us.census.tiger.congressional_district
Elementary School District | "us.census.tiger".school_district_elementary Elementary School District | us.census.tiger.school_district_elementary
Secondary School District | "us.census.tiger".school_district_secondary Secondary School District | us.census.tiger.school_district_secondary
US Census Blocks | "us.census.tiger".block US Census Blocks | us.census.tiger.block
#### OBS_GetUSCensusMeasure names table #### OBS_GetUSCensusMeasure names table

6
src/pg/sql/40_observatory_utility.sql
View File

@ -4,7 +4,7 @@
-- table where there is multiple sources for a column from multiple -- table where there is multiple sources for a column from multiple
-- geometries. -- geometries.
CREATE OR REPLACE FUNCTION cdb_observatory._OBS_GeomTable( CREATE OR REPLACE FUNCTION cdb_observatory._OBS_GeomTable(
geom geometry, geom geometry(Geometry, 4326),
geometry_id text, geometry_id text,
time_span text DEFAULT NULL time_span text DEFAULT NULL
) )
@ -84,7 +84,7 @@ $$ LANGUAGE plpgsql;
--Test point cause Stuart always seems to make random points in the water --Test point cause Stuart always seems to make random points in the water
CREATE OR REPLACE FUNCTION cdb_observatory._TestPoint() CREATE OR REPLACE FUNCTION cdb_observatory._TestPoint()
RETURNS geometry RETURNS geometry(Point, 4326)
AS $$ AS $$
BEGIN BEGIN
-- new york city -- new york city
@ -95,7 +95,7 @@ $$ LANGUAGE plpgsql;
--Test polygon cause Stuart always seems to make random points in the water --Test polygon cause Stuart always seems to make random points in the water
-- TODO: remove as it's not used anywhere? -- TODO: remove as it's not used anywhere?
CREATE OR REPLACE FUNCTION cdb_observatory._TestArea() CREATE OR REPLACE FUNCTION cdb_observatory._TestArea()
RETURNS geometry RETURNS geometry(Geometry, 4326)
AS $$ AS $$
BEGIN BEGIN
-- Buffer NYC point by 500 meters -- Buffer NYC point by 500 meters

50
src/pg/sql/41_observatory_augmentation.sql
View File

@ -22,7 +22,7 @@
-- Creates a table of demographic snapshot -- Creates a table of demographic snapshot
CREATE OR REPLACE FUNCTION cdb_observatory.OBS_GetDemographicSnapshot(geom geometry, CREATE OR REPLACE FUNCTION cdb_observatory.OBS_GetDemographicSnapshot(geom geometry(Geometry, 4326),
time_span text DEFAULT NULL, time_span text DEFAULT NULL,
boundary_id text DEFAULT NULL) boundary_id text DEFAULT NULL)
RETURNS SETOF JSON RETURNS SETOF JSON
@ -140,7 +140,7 @@ $$ LANGUAGE plpgsql;
-- Base augmentation fucntion. -- Base augmentation fucntion.
CREATE OR REPLACE FUNCTION cdb_observatory._OBS_Get( CREATE OR REPLACE FUNCTION cdb_observatory._OBS_Get(
geom geometry, geom geometry(Geometry, 4326),
column_ids text[], column_ids text[],
time_span text, time_span text,
geometry_level text geometry_level text
@ -163,26 +163,24 @@ BEGIN
RETURN QUERY SELECT '{}'::text[], '{}'::NUMERIC[]; RETURN QUERY SELECT '{}'::text[], '{}'::NUMERIC[];
END IF; END IF;
execute' EXECUTE
select array_agg( _obs_getcolumndata) from cdb_observatory._OBS_GetColumnData($1, 'SELECT array_agg(_obs_getcolumndata)
$2, FROM cdb_observatory._OBS_GetColumnData($1, $2, $3);'
$3);' INTO data_table_info
INTO data_table_info USING geometry_level, column_ids, time_span;
using geometry_level, column_ids, time_span;
IF ST_GeometryType(geom) = 'ST_Point' IF ST_GeometryType(geom) = 'ST_Point'
THEN THEN
RAISE NOTICE 'geom_table_name %, data_table_info %', geom_table_name, data_table_info::json[]; RAISE NOTICE 'geom_table_name %, data_table_info %', geom_table_name, data_table_info::json[];
results := cdb_observatory._OBS_GetPoints(geom, results := cdb_observatory._OBS_GetPoints(geom,
geom_table_name, geom_table_name,
data_table_info); data_table_info);
ELSIF ST_GeometryType(geom) IN ('ST_Polygon', 'ST_MultiPolygon') ELSIF ST_GeometryType(geom) IN ('ST_Polygon', 'ST_MultiPolygon')
THEN THEN
-- RAISE EXCEPTION 'polygons not supported for now';
results := cdb_observatory._OBS_GetPolygons(geom, results := cdb_observatory._OBS_GetPolygons(geom,
geom_table_name, geom_table_name,
data_table_info); data_table_info);
END IF; END IF;
RETURN QUERY RETURN QUERY
@ -199,7 +197,7 @@ $$ LANGUAGE plpgsql;
-- If the variable of interest is just a rate return it as such, -- If the variable of interest is just a rate return it as such,
-- otherwise normalize it to the census block area and return that -- otherwise normalize it to the census block area and return that
CREATE OR REPLACE FUNCTION cdb_observatory._OBS_GetPoints( CREATE OR REPLACE FUNCTION cdb_observatory._OBS_GetPoints(
geom geometry, geom geometry(Geometry, 4326),
geom_table_name text, geom_table_name text,
data_table_info json[] data_table_info json[]
) )
@ -208,17 +206,17 @@ AS $$
DECLARE DECLARE
result NUMERIC[]; result NUMERIC[];
json_result json[]; json_result json[];
query text; query text;
i int; i int;
geoid text; geoid text;
area NUMERIC; area NUMERIC;
BEGIN BEGIN
-- TODO: does 'geoid' need to be generalized to geom_ref?? -- TODO: does 'geoid' need to be generalized to geom_ref??
EXECUTE EXECUTE
format('SELECT geoid format('SELECT geoid
FROM observatory.%I FROM observatory.%I
WHERE ST_WITHIN($1, the_geom)', WHERE ST_Within($1, the_geom)',
geom_table_name) geom_table_name)
USING geom USING geom
INTO geoid; INTO geoid;
@ -283,7 +281,7 @@ BEGIN
meta->>'name' As name, meta->>'name' As name,
meta->>'tablename' As tablename, meta->>'tablename' As tablename,
meta->>'aggregate' As aggregate, meta->>'aggregate' As aggregate,
meta->>'type' As type, meta->>'type' As type,
meta->>'description' As description meta->>'description' As description
FROM (SELECT unnest($1) As values, unnest($2) As meta) b FROM (SELECT unnest($1) As values, unnest($2) As meta) b
) t ) t
@ -297,7 +295,7 @@ $$ LANGUAGE plpgsql;
CREATE OR REPLACE FUNCTION cdb_observatory.OBS_GetMeasure( CREATE OR REPLACE FUNCTION cdb_observatory.OBS_GetMeasure(
geom GEOMETRY, geom geometry(Geometry, 4326),
measure_id TEXT, measure_id TEXT,
normalize TEXT DEFAULT 'area', -- TODO none/null normalize TEXT DEFAULT 'area', -- TODO none/null
boundary_id TEXT DEFAULT NULL, boundary_id TEXT DEFAULT NULL,
@ -352,7 +350,7 @@ $$ LANGUAGE plpgsql;
CREATE OR REPLACE FUNCTION cdb_observatory.OBS_GetCategory( CREATE OR REPLACE FUNCTION cdb_observatory.OBS_GetCategory(
geom GEOMETRY, geom geometry(Geometry, 4326),
category_id TEXT, category_id TEXT,
boundary_id TEXT DEFAULT NULL, boundary_id TEXT DEFAULT NULL,
time_span TEXT DEFAULT NULL time_span TEXT DEFAULT NULL
@ -386,7 +384,7 @@ END;
$$ LANGUAGE plpgsql; $$ LANGUAGE plpgsql;
CREATE OR REPLACE FUNCTION cdb_observatory.OBS_GetUSCensusMeasure( CREATE OR REPLACE FUNCTION cdb_observatory.OBS_GetUSCensusMeasure(
geom GEOMETRY, geom geometry(Geometry, 4326),
name TEXT, name TEXT,
normalize TEXT DEFAULT 'area', normalize TEXT DEFAULT 'area',
boundary_id TEXT DEFAULT NULL, boundary_id TEXT DEFAULT NULL,
@ -419,7 +417,7 @@ END;
$$ LANGUAGE plpgsql; $$ LANGUAGE plpgsql;
CREATE OR REPLACE FUNCTION cdb_observatory.OBS_GetUSCensusCategory( CREATE OR REPLACE FUNCTION cdb_observatory.OBS_GetUSCensusCategory(
geom GEOMETRY, geom geometry(Geometry, 4326),
name TEXT, name TEXT,
boundary_id TEXT DEFAULT NULL, boundary_id TEXT DEFAULT NULL,
time_span TEXT DEFAULT NULL time_span TEXT DEFAULT NULL
@ -453,7 +451,7 @@ END;
$$ LANGUAGE plpgsql; $$ LANGUAGE plpgsql;
CREATE OR REPLACE FUNCTION cdb_observatory.OBS_GetPopulation( CREATE OR REPLACE FUNCTION cdb_observatory.OBS_GetPopulation(
geom geometry, geom geometry(Geometry, 4326),
normalize TEXT DEFAULT 'area', normalize TEXT DEFAULT 'area',
boundary_id TEXT DEFAULT NULL, boundary_id TEXT DEFAULT NULL,
time_span TEXT DEFAULT NULL time_span TEXT DEFAULT NULL
@ -478,7 +476,7 @@ $$ LANGUAGE plpgsql;
CREATE OR REPLACE FUNCTION cdb_observatory._OBS_GetPolygons( CREATE OR REPLACE FUNCTION cdb_observatory._OBS_GetPolygons(
geom geometry, geom geometry(Geometry, 4326),
geom_table_name text, geom_table_name text,
data_table_info json[] data_table_info json[]
) )
@ -558,7 +556,7 @@ $$ LANGUAGE plpgsql;
CREATE OR REPLACE FUNCTION cdb_observatory.OBS_GetSegmentSnapshot( CREATE OR REPLACE FUNCTION cdb_observatory.OBS_GetSegmentSnapshot(
geom geometry, geom geometry(Geometry, 4326),
boundary_id text DEFAULT NULL boundary_id text DEFAULT NULL
) )
RETURNS JSON RETURNS JSON
@ -666,7 +664,7 @@ $$ LANGUAGE plpgsql;
--Get categorical variables from point --Get categorical variables from point
CREATE OR REPLACE FUNCTION cdb_observatory._OBS_GetCategories( CREATE OR REPLACE FUNCTION cdb_observatory._OBS_GetCategories(
geom geometry, geom geometry(Geometry, 4326),
dimension_names text[], dimension_names text[],
boundary_id text DEFAULT NULL, boundary_id text DEFAULT NULL,
time_span text DEFAULT NULL time_span text DEFAULT NULL

4
src/pg/sql/42_observatory_exploration.sql
View File

@ -81,8 +81,8 @@ $$ LANGUAGE plpgsql;
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
-- TODO add test response -- TODO add test response
CREATE OR REPLACE FUNCTION OBS_GetAvailableBoundaries( CREATE OR REPLACE FUNCTION cdb_observatory.OBS_GetAvailableBoundaries(
geom geometry, geom geometry(Geometry, 4326),
timespan text DEFAULT null) timespan text DEFAULT null)
RETURNS TABLE(boundary_id text, description text, time_span text, tablename text) as $$ RETURNS TABLE(boundary_id text, description text, time_span text, tablename text) as $$
DECLARE DECLARE

8
src/pg/sql/44_observatory_geometries.sql
View File

@ -22,7 +22,7 @@
-- --
CREATE OR REPLACE FUNCTION cdb_observatory.OBS_GetBoundary( CREATE OR REPLACE FUNCTION cdb_observatory.OBS_GetBoundary(
geom geometry(Geometry, 4326), geom geometry(Point, 4326),
boundary_id text, boundary_id text,
time_span text DEFAULT NULL) time_span text DEFAULT NULL)
RETURNS geometry(Geometry, 4326) RETURNS geometry(Geometry, 4326)
@ -104,7 +104,7 @@ $$ LANGUAGE plpgsql;
-- --
CREATE OR REPLACE FUNCTION cdb_observatory.OBS_GetBoundaryId( CREATE OR REPLACE FUNCTION cdb_observatory.OBS_GetBoundaryId(
geom geometry(Geometry, 4326), geom geometry(Point, 4326),
boundary_id text, boundary_id text,
time_span text DEFAULT NULL time_span text DEFAULT NULL
) )
@ -344,7 +344,7 @@ $$ LANGUAGE plpgsql;
-- --
-- TODO: move to ST_DWithin instead of buffer + intersects? -- TODO: move to ST_DWithin instead of buffer + intersects?
CREATE OR REPLACE FUNCTION cdb_observatory.OBS_GetBoundariesByPointAndRadius( CREATE OR REPLACE FUNCTION cdb_observatory.OBS_GetBoundariesByPointAndRadius(
geom geometry(Geometry, 4326), -- point geom geometry(Point, 4326), -- point
radius numeric, -- radius in meters radius numeric, -- radius in meters
boundary_id text, boundary_id text,
time_span text DEFAULT NULL, time_span text DEFAULT NULL,
@ -485,7 +485,7 @@ $$ LANGUAGE plpgsql;
-- --
CREATE OR REPLACE FUNCTION cdb_observatory.OBS_GetPointsByPointAndRadius( CREATE OR REPLACE FUNCTION cdb_observatory.OBS_GetPointsByPointAndRadius(
geom geometry(Geometry, 4326), -- point geom geometry(Point, 4326), -- point
radius numeric, -- radius in meters radius numeric, -- radius in meters
boundary_id text, boundary_id text,
time_span text DEFAULT NULL, time_span text DEFAULT NULL,