From: Regina Obe <lr@pcorp.us>
Date: Tue, 27 Dec 2011 16:33:14 +0000 (+0000)
Subject: document ST_HillShade (still need to put in examples)
X-Git-Tag: 2.0.0alpha1~279
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=220bf4b398821ded154eb89370dc34ad9aaeec70;p=postgis

document ST_HillShade (still need to put in examples)

git-svn-id: http://svn.osgeo.org/postgis/trunk@8596 b70326c6-7e19-0410-871a-916f4a2858ee
---

diff --git a/doc/reference_raster.xml b/doc/reference_raster.xml
index 4f252d221..3c8f0a3bf 100644
--- a/doc/reference_raster.xml
+++ b/doc/reference_raster.xml
@@ -5331,6 +5331,46 @@ FROM dummy_rast;
 			</refsection>
 		</refentry>
 		
+		<refentry id="RT_ST_HillShade">
+			<refnamediv>
+				<refname>ST_HillShade</refname>
+				<refpurpose>Returns the hypothetical illumination of a raster band using azimuth, altitude, brightness, and elevation scale inputs</refpurpose>
+			</refnamediv>
+			<refsynopsisdiv>
+				<funcsynopsis>
+				  <funcprototype>
+					<funcdef>raster <function>ST_HillShade</function></funcdef>
+					<paramdef><type>raster </type> <parameter>rast</parameter></paramdef>
+					<paramdef><type>integer </type> <parameter>band</parameter></paramdef>
+					<paramdef><type>text </type> <parameter>pixeltype</parameter></paramdef>
+					<paramdef><type>double precision </type> <parameter>azimuth</parameter></paramdef>
+					<paramdef choice='opt'><type>double precision </type> <parameter>max_bright=255</parameter></paramdef>
+					<paramdef choice='opt'><type>double precision </type> <parameter>elevation_scale=1</parameter></paramdef>
+				  </funcprototype>
+			</refsynopsisdiv>
+		
+			<refsection>
+				<title>Description</title>
+				
+				<para>Returns the hypothetical illumination of a raster band using the azimuth, altitude, brightness, and elevation scale inputs. Utilizes map algebra and
+				applies the hill shade equation to neighboring pixels.</para>
+				<para>The hill shade equation is: <programlisting>max_bright * ( (cos(zenith)*cos(slope)) + (sin(zenith)*sin(slope)*cos(azimuth - aspect)) )</programlisting>.</para>
+				<para>Availability: 2.0.0 </para>
+				<para>Examples here use Massachusetts aerial data available on MassGIS site <ulink url="http://www.mass.gov/mgis/colororthos2008.htm">MassGIS Aerial Orthos</ulink>. Coordinates are in Massachusetts State Plane Meters.</para>
+			</refsection>
+				
+			<refsection>
+				<title>Examples - comming soon</title>				
+<programlisting>coming soon</programlisting>
+
+			</refsection>
+			<!-- Optionally add a "See Also" section -->
+			<refsection>
+				<title>See Also</title>
+				<para><xref linkend="RT_ST_MapAlgebraFctNgb" /></para>
+			</refsection>
+		</refentry>
+		
 		<refentry id="RT_ST_Intersection">
 			<refnamediv>
 				<refname>ST_Intersection</refname>