<!--
(C) Copyright 1996-2016 ECMWF.
This software is licensed under the terms of the Apache Licence Version 2.0
which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
In applying this licence, ECMWF does not waive the privileges and immunities
granted to it by virtue of its status as an intergovernmental organisation nor
does it submit to any jurisdiction.
-->
<magics>
	<class xmltag="contour"
		name="Contour"
		metview="MCONT"
		action="pcont"
		prefix="contour"
		directory="visualisers"
		fortan="pcont"
		python="mcont"
		python_rank="1"
		root="contour">
		<userdoc>
		This action controls the plotting of isolines, contour bands and grid points.
		It is used to plot gridded data, such as fields.
		</userdoc>
		<documentation>
    This controls the plotting of isolines, contour bands and grid points.
		</documentation>
		<parameter member="legend"
			to="bool"
			default="off"
			from="string"
			name="legend">
			<documentation>Turn legend on or off</documentation>
			<release>2.12</release>
			<set name="contour_special_legend" value="on"></set>
			<set name="contour_legend_text" value="on"></set>
		</parameter>
		<parameter member="contour"
			to="IsoPlot"
			default="on"
			from="string"
			values="on/off"
			name="contour">
			<documentation>Turn contouring on or off</documentation>
			<option xml="isoline" fortran="on" include="IsoPlot.h" name="IsoPlot"></option>
			<option xml="noisoline" fortran="off" include="IsoPlot.h" name="NoIsoPlot"></option>
		</parameter>
		<parameter member="description"
			to="string"
			default=""
			from="string"
			name="contour_description">
			<documentation>Description of the contouring, use in contour libraries</documentation>
		</parameter>
		<parameter member="title"
			to="string"
			default=""
			from="string"
			name="contour_title">
			<documentation>Title of the contouring, use in contour libraries</documentation>
		</parameter>
		<parameter member="method"
			to="ContourMethod"
			default="automatic"
			from="string"
			values="automatic/linear/akima474/akima760"
			name="contour_method">
			<documentation>Contouring method</documentation>
			<option xml="automatic" fortran="automatic" include="AutomaticContourMethod.h" name="AutomaticContourMethod"></option>
			<option xml="linear" fortran="linear" include="ContourMethod.h" name="ContourMethod"></option>
			<option xml="akima760" fortran="akima760" include="Akima760Method.h" name="Akima760Method"></option>
			<option xml="akima474" fortran="akima474" include="Akima474Method.h" name="Akima474Method"></option>
			<release>0.1</release>
			<release>Two akima algorithms have been implemented akima760/akima474</release>
		</parameter>
		<parameter member="floor"
			to="float"
			default="-INT_MAX"
			from="float"
			name="contour_interpolation_floor">
			<documentation>Any value below this floor will be forced  to the floor value.
		avoid the bubbles artificially created by the interpolation method</documentation>
			<release_info>2.8</release_info>
		</parameter>
		<parameter member="ceiling"
			to="float"
			default="INT_MAX"
			from="float"
			name="contour_interpolation_ceiling">
			<documentation>any value above this ceiling will be forced  to the ceiling value.
		avoid the bubbles artificially created by the interpolation method</documentation>
			<release_info>2.8</release_info>
		</parameter>
		<parameter from="string"
			name="contour_automatic_setting"
			default="off"
			member="setting"
			to="string"
			values="off/style_name/ecmwf">
			<documentation>Turn the automatic setting of contouring attributes</documentation>
			<unset name="contour_automatic_library_path" value="off"></unset>
			<set name="contour_style_name" value="style_name"></set>
		</parameter>
		<parameter from="string"
			name="contour_style_name"
			default=""
			member="predefined"
			to="string">
			<documentation>Use of a predeined setting</documentation>
		</parameter>
		<parameter from="string"
			name="contour_metadata_only"
			default="off"
			member="metadata_only"
			to="bool">
			<documentation>Only get the metadata</documentation>
		</parameter>
		<parameter from="string"
			name="contour_automatic_library_path"
			visible="off"
			python="off"
			default=""
			member="library_path"
			to="string">
			<documentation>Users can give their own directory to setup the automatic library of contours</documentation>
		</parameter>
		<parameter from="string"
			name="contour_units"
			default=""
			member="units"
			to="string">
			<documentation>Units used to define contour attributes</documentation>
		</parameter>
		<parameter member="hilo"
			to="HiLoBase"
			default="off"
			from="string"
			values="on/off"
			name="contour_hilo">
			<documentation>Plot local maxima/minima</documentation>
			<option xml="hilo" fortran="on" include="HiLo.h" name="HiLo"></option>
			<option xml="nohilo" fortran="off" include="HiLo.h" name="NoHiLo"></option>
			<option xml="high" fortran="hi" include="HiLo.h" name="HighHiLo"></option>
			<option xml="low" fortran="lo" include="HiLo.h" name="LowHiLo"></option>
			<set name="contour_hilo_type" value="on/hi/lo"></set>
			<set name="contour_hilo_blanking" value="on/hi/lo"></set>
			<set name="contour_hilo_format" value="on/hi/lo"></set>
			<set name="contour_hilo_window_size" value="on/hi/lo"></set>
			<set name="contour_hilo_reduction_radius" value="on/hi/lo"></set>
			<set name="contour_hilo_suppress_radius" value="on/hi/lo"></set>
			<set name="contour_hilo_max_value" value="on/hi/lo"></set>
			<set name="contour_hilo_min_value" value="on/hi/lo"></set>
			<set name="contour_hi_text" value="on/hi"></set>
			<set name="contour_lo_text" value="on/lo"></set>
			<set name="contour_hi_max_value" value="on/hi"></set>
			<set name="contour_hi_min_value" value="on/hi"></set>
			<set name="contour_lo_max_value" value="on/lo"></set>
			<set name="contour_lo_min_value" value="on/lo"></set>
			<set name="contour_hilo_marker" value="on/hi/lo"></set>
			<set name="contour_lo_colour" value="on/lo"></set>
			<set name="contour_hi_colour" value="on/hi"></set>
			<set name="contour_hilo_marker_height" value="on/hi/lo"></set>
			<set name="contour_hilo_marker_index" value="on/hi/lo"></set>
			<set name="contour_hilo_marker_colour" value="on/hi/lo"></set>
			<set name="contour_hilo_position_file_name" value="on/hi/lo"></set>
			<set name="contour_hilo_height" value="on/hi/lo"></set>
			<set name="contour_hilo_quality" value="on/hi/lo"></set>
		</parameter>
		<parameter member="grid"
			to="ValuePlotBase"
			default="off"
			from="string"
			values="on/off"
			name="contour_grid_value_plot">
			<documentation>Plot Grid point values</documentation>
			<option xml="gridvalues" fortran="on" include="ValuePlot.h" name="ValuePlot"></option>
			<option xml="nogridvalues" fortran="off" include="ValuePlot.h" name="NoValuePlot"></option>
			<release>Magics++0.3</release>
		</parameter>
		<metview_parameter default="on" to="bool" from="string" name="grib_scaling_of_retrieved_fields">
			<documentation>Certain parameters will be scaled into more user-friendly units if the data has not been manipulated</documentation>
		</metview_parameter>
		<metview_parameter default="off" to="bool" from="string" name="grib_scaling_of_derived_fields">
			<documentation>Certain parameters will be scaled into more user-friendly units if the data has been manipulated</documentation>
		</metview_parameter>
	</class>
</magics>
