Magnetic Isolines (Foundation) |
|
|
Release 9.2
Last modified July 31, 2007 |
Print all topics in : "Magnetic" |
Magnetic Isolines allows you to draw isomagnetic lines in an extent for a date between the years 2005 and 2010 based on the World Magnetic Model. The tool draws the lines based on the magnetic field variable you choose and the method you choose to generate the lines.
The extent you use as input can come from a feature class, layer, elevation raster, or elevation raster dataset. You can further narrow the input using a selection set.
The magnetic field variables available are:
For a description of a variable, click in the Magnetic Field Parameter text box in the tool and view the side-panel help.
You must provide an altitude in one of two ways described in the side-panel help for the Altitude field.
When you run the tool, it steps through several general processes before drawing the lines on the map:
For more information about how the tool works and using selection sets, view the tool's overview topics by clicking the Help button just above this topic, then, in the left panel of the help dialog box that displays, navigating to PLTS Foundation toolbox > Magnetic toolset > Tools.
Usage tips
Magnetic Isolines requires ArcGIS Spatial Analyst.
To use grid variation for isoline generation, you must be using a coordinate system of Lambert Conformal Conic type. This is a continental projected coordinate system. If your input is not Lambert Conformal Conic, you may have to specify Lambert Conformal Conic in the environments settings. For more information, click in the Magnetic Field Parameter text box and view the side-panel help.
You must provide an altitude in one of two ways described in the side-panel help for the Altitude field.
Command line syntax
An overview of the Command Line window
MagneticIsolines_foundation <FEATURE CLASS|LAYER|RASTER> {where_clause} <altitude> <METERS|UNKNOWN|POINTS|FEET|YARDS|MILES|NAUTICAL MILES|MILLIMETERS|CENTIMETERS|KILOMETERS|DECIMAL DEGREES|DECIMETERS> <date> {out_features} {NORTHERLY(NANOTESLA)|EASTERLY(NANOTESLA)|VERTICAL(NANOTESLA)|INCLINATION(DECIMALDEGREES)|DECLINATION(DECIMALDEGREES)|TOTALINTENSITY(NANOTESLA)|HORIZONTALINTENSITY(NANOTESLA)|ANNUALDRIFT(DECIMALDEGREESPERYEAR)|GRIDVARIATION(DECIMALDEGREES)} <cell_size> {base_value} {isoline_interval} {isoline_values;isoline_values...}
| Parameter | Explanation | Data Type |
| <FEATURE CLASS|LAYER|RASTER> |
The path to and name of the feature class, elevation raster, or elevation raster dataset for which you want to generate isolines. This field is required. |
String |
| {where_clause} |
A query expression Magnetic Isolines can use to determine which data to analyze when you run the tool. Use this field if you want to generate magnetic isolines for data that meets certain criteria. Type SQL query syntax to specify this criteria. |
String |
| <altitude> |
The elevation data required by the tool. If your input data is non-raster, the tool will apply the altitude value you type in this field globally to the input (or selection set). If your input data is an elevation raster, the altitude data you provide will have no significance. The value you provide must be between 0 and 1000000. Note that the value does not get applied to the input or output data; the tool just uses it for its calculations. You must choose the type of linear units you want to use for altitude. Choices include points, feet, yards, miles, nautical miles, millimeters, centimeters, meters, kilometers, decimal degrees, and decimeters. |
Double |
| <METERS|UNKNOWN|POINTS|FEET|YARDS|MILES|NAUTICAL MILES|MILLIMETERS|CENTIMETERS|KILOMETERS|DECIMAL DEGREES|DECIMETERS> |
The linear units of measurement you want to use for the altitude. Choices include points, feet, yards, miles, nautical miles, millimeters, centimeters, meters, kilometers, decimal degrees, and decimeters. |
String |
| <date> |
The date for which you want magnetic field values to be calculated. The date must be between the years 2005 and 2010 (the last date available in this release is 12/31/2009). Type the date in mm/dd/yyyy format. |
Date |
| {out_features} |
The path to and name of a line feature class or line layer to which the tool will output data. If you type the path to and name of an existing feature class or layer, the tool will overwrite it. If you type the path to and name of a new feature class or layer, the tool will create a new one to store the output data. Make sure the path includes a geodatabase (most feature classes must be stored in a geodatabase). |
String |
| {NORTHERLY(NANOTESLA)|EASTERLY(NANOTESLA)|VERTICAL(NANOTESLA)|INCLINATION(DECIMALDEGREES)|DECLINATION(DECIMALDEGREES)|TOTALINTENSITY(NANOTESLA)|HORIZONTALINTENSITY(NANOTESLA)|ANNUALDRIFT(DECIMALDEGREESPERYEAR)|GRIDVARIATION(DECIMALDEGREES)} |
The magnetic field variable for which you want isolines generated. You must choose one. Descriptions of each variable are below.
For details about the logic Magnetic Isolines uses to determine spatial reference, see "How the spatial reference is determined for grid variation" in the tool's geoprocessing overview topics (click the Help icon above, then in the left panel of the dialog box that appears, click Magnetic > Magnetic Isolines, click Related Topics, then click "How the spatial reference is determined for grid variation". |
String |
| <cell_size> |
The size you want each cell in the raster to be. The raster in this case is either the raster you provided as input data or the temporary raster the tool generates to calculate isolines for non-raster input data. The temporary raster is also known as the constant raster. The size you type into this text box determines how many cells the raster will be divided into by the tool. The number of cells in a raster determines its resolution. To calculate this number of cells, the tool uses the cell size you give it here and either the width or height — whichever is shortest — of the extent of the input data. For example, if the size of your raster is 1,000 units by 1,500 units and you type 2 in this text box, the tool will divide the raster into 500 cells. If you do not provide a cell size value, the tool uses a value that divides the raster into 250 cells. This default cell size value displays in this text box as soon as you specify an input, but you can change it before you run the tool to any cell size you want. If a coordinate system is defined for/associated with the raster, the size units are linear units; otherwise they are raster pixels. |
Double |
| {base_value} |
A magnetic value the tool uses in the isoline interval method. The isoline interval method is one of two methods you can use to generate isolines. With this method, isolines are drawn based on two values you provide, a base value and an interval value. The base value is the magnetic value for which you want the tool to start generating isolines. The interval value is the increment for which you want the tool to generate lines after it generates the base value line. Technically, the lines aren't actually generated until you open the output in ArcMap or ArcCatalog; but the information to draw the lines is created and stored in the output. The output is always a new line feature class. The units for both values are the same as those specified for the magnetic field variable you chose to calculate. Inclination and declination are in decimal degrees. The other variables' units are nano Teslas. For example, if you chose declination as the magnetic value you want to calculate and provided a base value of 0 and an interval value of 3, the tool:
(2) Creates a set of intermediate rasters in a temporary directory; they are deleted after the tool has finished its computations. (3) Creates a shapefile named wmmpoint in your C:\Documents and Settings\<user name>\Local Settings\Temp directory and creates a raster named WMMInRaster in the same directory. These items also appear in the ArcMap table of contents if you have ArcMap open. (4) Creates the information needed to draw isolines (to draw a line between each set of points that have the same magnetic value) on the map. Stores only the line information needed to draw the lines at the base and interval magnetic values you specified. When you open the output in ArcMap or ArcCatalog, a line will be drawn that connects all points that have 0 decimal degrees as their declination value; a line will be drawn that connects all points that have 3 decimal degrees as their declination value, then one for all points that have 6, then 9, and so on. |
Double |
| {isoline_interval} |
An increment value the tool uses in the isoline interval method. The isoline interval method is one of two methods you can use to generate isolines. Type a numeric value in this field (and one in the base value field) if you want to use this method. With this method, isolines are drawn based on two values you provide, a base value and an interval value. The base value is the magnetic value for which you want the tool to start generating isolines. The interval value is the increment for which you want the tool to generate lines after it generates the base value line. Technically, the lines aren't actually generated until you open the output in ArcMap or ArcCatalog; but the information to draw the lines is created and stored in the output. The units for both values are the same as those specified for the magnetic field variable you chose to calculate. Inclination and declination are in decimal degrees. The other variables' units are nano Teslas. For example, if you chose declination as the magnetic value you want to calculate and provided a base value of 0 and an interval value of 3, the tool:
(2) Creates a set of intermediate rasters in a temporary directory; they are deleted after the tool has finished its computations. (3) Creates a shapefile named wmmpoint in your C:\Documents and Settings\<user name>\Local Settings\Temp directory and creates a raster named WMMInRaster in the same directory. These items also appear in the ArcMap table of contents if you have ArcMap open. (4) Creates the information needed to draw isolines (to draw a line between each set of points that have the same magnetic value) on the map. Stores only the line information needed to draw the lines at the base and interval magnetic values you specified. When you open the output in ArcMap or ArcCatalog, a line will be drawn that connects all points that have 0 decimal degrees as their declination value; a line will be drawn that connects all points that have 3 decimal degrees as their declination value, then one for all points that have 6, then 9, and so on. |
Double |
| {isoline_values;isoline_values...} |
A list of magnetic values that the tool uses in the Isoline Value List method to compute how isolines should be drawn. In this method, the tool takes the first magnetic value you provide (the first value in the list) and draws a line connecting all of the points that have the first magnetic value. It takes the second value you provide and draws a line connecting all of the points that have the second magnetic value, and so on until it has drawn a line for every value you provided. Which magnetic value (variable) the tool uses in its computations is determined by which variable you have selected in the tool's Magnetic Field Parameter drop-down list. |
Double |
MagneticIsolines 'C:\Program Files\PLTS\sample\SouthernCalifornia\SoCal.mdb\SoCal\ElevP' # 100 Feet 4/1/2007'C:\Program Files\PLTS\sample\SouthernCalifornia\SoCal_magnetic.mdb\my_output' Declination .005 0 .002 #
Scripting syntax
About getting started with writing geoprocessing scripts
MagneticIsolines_foundation (in_extent, where_clause, altitude, altitude_unit, date, out_features, magnetic_field, cell_size, base_value, isoline_interval, isoline_values)
| Parameter | Explanation | Data Type |
| in_extent (Required) |
The path to and name of the feature class, elevation raster, or elevation raster dataset for which you want to generate isolines. This field is required. |
String |
| where_clause (Optional) |
A query expression Magnetic Isolines can use to determine which data to analyze when you run the tool. Use this field if you want to generate magnetic isolines for data that meets certain criteria. Type SQL query syntax to specify this criteria. |
String |
| altitude (Required) |
The elevation data required by the tool. If your input data is non-raster, the tool will apply the altitude value you type in this field globally to the input (or selection set). If your input data is an elevation raster, the altitude data you provide will have no significance. The value you provide must be between 0 and 1000000. Note that the value does not get applied to the input or output data; the tool just uses it for its calculations. You must choose the type of linear units you want to use for altitude. Choices include points, feet, yards, miles, nautical miles, millimeters, centimeters, meters, kilometers, decimal degrees, and decimeters. |
Double |
| altitude_unit (Required) |
The linear units of measurement you want to use for the altitude. Choices include points, feet, yards, miles, nautical miles, millimeters, centimeters, meters, kilometers, decimal degrees, and decimeters. |
String |
| date (Required) |
The date for which you want magnetic field values to be calculated. The date must be between the years 2005 and 2010 (the last date available in this release is 12/31/2009). Type the date in mm/dd/yyyy format. |
Date |
| out_features (Optional) |
The path to and name of a line feature class or line layer to which the tool will output data. If you type the path to and name of an existing feature class or layer, the tool will overwrite it. If you type the path to and name of a new feature class or layer, the tool will create a new one to store the output data. Make sure the path includes a geodatabase (most feature classes must be stored in a geodatabase). |
String |
| magnetic_field (Optional) |
The magnetic field variable for which you want isolines generated. You must choose one. Descriptions of each variable are below.
For details about the logic Magnetic Isolines uses to determine spatial reference, see "How the spatial reference is determined for grid variation" in the tool's geoprocessing overview topics (click the Help icon above, then in the left panel of the dialog box that appears, click Magnetic > Magnetic Isolines, click Related Topics, then click "How the spatial reference is determined for grid variation". |
String |
| cell_size (Required) |
The size you want each cell in the raster to be. The raster in this case is either the raster you provided as input data or the temporary raster the tool generates to calculate isolines for non-raster input data. The temporary raster is also known as the constant raster. The size you type into this text box determines how many cells the raster will be divided into by the tool. The number of cells in a raster determines its resolution. To calculate this number of cells, the tool uses the cell size you give it here and either the width or height — whichever is shortest — of the extent of the input data. For example, if the size of your raster is 1,000 units by 1,500 units and you type 2 in this text box, the tool will divide the raster into 500 cells. If you do not provide a cell size value, the tool uses a value that divides the raster into 250 cells. This default cell size value displays in this text box as soon as you specify an input, but you can change it before you run the tool to any cell size you want. If a coordinate system is defined for/associated with the raster, the size units are linear units; otherwise they are raster pixels. |
Double |
| base_value (Optional) |
A magnetic value the tool uses in the isoline interval method. The isoline interval method is one of two methods you can use to generate isolines. With this method, isolines are drawn based on two values you provide, a base value and an interval value. The base value is the magnetic value for which you want the tool to start generating isolines. The interval value is the increment for which you want the tool to generate lines after it generates the base value line. Technically, the lines aren't actually generated until you open the output in ArcMap or ArcCatalog; but the information to draw the lines is created and stored in the output. The output is always a new line feature class. The units for both values are the same as those specified for the magnetic field variable you chose to calculate. Inclination and declination are in decimal degrees. The other variables' units are nano Teslas. For example, if you chose declination as the magnetic value you want to calculate and provided a base value of 0 and an interval value of 3, the tool:
(2) Creates a set of intermediate rasters in a temporary directory; they are deleted after the tool has finished its computations. (3) Creates a shapefile named wmmpoint in your C:\Documents and Settings\<user name>\Local Settings\Temp directory and creates a raster named WMMInRaster in the same directory. These items also appear in the ArcMap table of contents if you have ArcMap open. (4) Creates the information needed to draw isolines (to draw a line between each set of points that have the same magnetic value) on the map. Stores only the line information needed to draw the lines at the base and interval magnetic values you specified. When you open the output in ArcMap or ArcCatalog, a line will be drawn that connects all points that have 0 decimal degrees as their declination value; a line will be drawn that connects all points that have 3 decimal degrees as their declination value, then one for all points that have 6, then 9, and so on. |
Double |
| isoline_interval (Optional) |
An increment value the tool uses in the isoline interval method. The isoline interval method is one of two methods you can use to generate isolines. Type a numeric value in this field (and one in the base value field) if you want to use this method. With this method, isolines are drawn based on two values you provide, a base value and an interval value. The base value is the magnetic value for which you want the tool to start generating isolines. The interval value is the increment for which you want the tool to generate lines after it generates the base value line. Technically, the lines aren't actually generated until you open the output in ArcMap or ArcCatalog; but the information to draw the lines is created and stored in the output. The units for both values are the same as those specified for the magnetic field variable you chose to calculate. Inclination and declination are in decimal degrees. The other variables' units are nano Teslas. For example, if you chose declination as the magnetic value you want to calculate and provided a base value of 0 and an interval value of 3, the tool:
(2) Creates a set of intermediate rasters in a temporary directory; they are deleted after the tool has finished its computations. (3) Creates a shapefile named wmmpoint in your C:\Documents and Settings\<user name>\Local Settings\Temp directory and creates a raster named WMMInRaster in the same directory. These items also appear in the ArcMap table of contents if you have ArcMap open. (4) Creates the information needed to draw isolines (to draw a line between each set of points that have the same magnetic value) on the map. Stores only the line information needed to draw the lines at the base and interval magnetic values you specified. When you open the output in ArcMap or ArcCatalog, a line will be drawn that connects all points that have 0 decimal degrees as their declination value; a line will be drawn that connects all points that have 3 decimal degrees as their declination value, then one for all points that have 6, then 9, and so on. |
Double |
| isoline_values (Optional) |
A list of magnetic values that the tool uses in the Isoline Value List method to compute how isolines should be drawn. In this method, the tool takes the first magnetic value you provide (the first value in the list) and draws a line connecting all of the points that have the first magnetic value. It takes the second value you provide and draws a line connecting all of the points that have the second magnetic value, and so on until it has drawn a line for every value you provided. Which magnetic value (variable) the tool uses in its computations is determined by which variable you have selected in the tool's Magnetic Field Parameter drop-down list. |
Double |
import sys, string, os, arcgisscripting# Create the Geoprocessor object
gp = arcgisscripting.create()# Load required toolboxes...
gp.AddToolbox("C:/Program Files/ArcGIS/ArcToolbox/Toolboxes/PLTS Foundation Tools.tbx")
# Local variables...
MagneticIsolinesL = "C:\\TestData\\PLTS 9.2\\SoCal.mdb\\SoCal\\MagneticIsolinesL" MagneticIsolinesL__2_ = "C:\\TestData\\PLTS 9.2\\SoCal.mdb\\SoCal\\MagneticIsolinesL" ElevP = "ElevP"# Process: Magnetic Isolines...
gp.MagneticIsolines_foundation(ElevP, "", "100", "Feet", "4/1/2007", MagneticIsolinesL, "Declination(Decimal Degrees)", "0.005", "0", "0.002", "")