Geo::GDAL::Driver Class Reference

A raster format driver. More...

Inheritance diagram for Geo::GDAL::Driver:

Collaboration diagram for Geo::GDAL::Driver:

Public Member Functions
public list	Capabilities ()
public Geo::GDAL::Dataset	Copy (scalar name, scalar src, scalar strict=1, hashref options=undef)
public method	CopyFiles ()
public Geo::GDAL::Dataset	Create (hash params)
public list	CreationDataTypes ()
public list	CreationOptionList ()
public method	Delete (scalar name)
public method	Domains ()
public scalar	Extension ()
public scalar	MIMEType ()
public scalar	Name ()
public method	Rename (scalar NewName, scalar OldName)
public scalar	TestCapability (scalar cap)
Public Member Functions inherited from Geo::GDAL::MajorObject
public scalar	Description (scalar description)
public method	Domains ()
public scalar	GetDescription ()
public hash reference	GetMetadata (scalar domain="")
public method	GetMetadataDomainList ()
public hash reference	Metadata (hashref metadata=undef, scalar domain= '')
public method	SetDescription (scalar NewDesc)
public method	SetMetadata (hashref metadata, scalar domain="")
Public Member Functions inherited from Geo::GDAL
public list	AccessTypes ()
public Geo::GDAL::Dataset	AutoCreateWarpedVRT (Geo::GDAL::Dataset src, Geo::OSR::SpatialReference src_srs=undef, Geo::OSR::SpatialReference dst_srs=undef, scalar ResampleAlg='NearestNeighbour', scalar maxerror=0.0)
public method	CPLBinaryToHex ()
public method	CPLHexToBinary ()
public list	Child (scalar node, scalar i)
public list	Children (scalar node)
public method	ComputeMedianCutPCT (Geo::GDAL::Band red, Geo::GDAL::Band green, Geo::GDAL::Band blue, scalar num_colors, scalar colors, subref progress, scalar progress_data)
public method	ComputeProximity (Geo::GDAL::Band src, Geo::GDAL::Band proximity, hashref options, subref progress, scalar progress_data)
public scalar	DataTypeIsComplex (scalar DataType)
public list	DataTypeValueRange (scalar DataType)
public list	DataTypes ()
public method	Debug ()
public scalar	DecToDMS (scalar angle, scalar axis, scalar precision=2)
public scalar	DecToPackedDMS (scalar dec)
public method	DitherRGB2PCT (scalar red, scalar green, scalar blue, scalar target, scalar colors, subref progress, scalar progress_data)
public method	EscapeString ()
public scalar	FindFile (scalar class, scalar basename)
public method	FinderClean ()
public method	GOA2GetAccessToken ()
public method	GOA2GetAuthorizationURL ()
public method	GOA2GetRefreshToken ()
public scalar	GetCacheMax ()
public scalar	GetCacheUsed ()
public scalar	GetConfigOption (scalar key, scalar default)
public scalar	GetDataTypeSize (scalar DataType)
public Geo::GDAL::Driver	GetDriver (scalar name)
public list	GetDriverNames ()
public method	GetJPEG2000StructureAsString ()
public Geo::GDAL::Driver	IdentifyDriver (scalar path, scalar siblings)
public list	NodeData (scalar node)
public scalar	NodeType (scalar type)
public list	NodeTypes ()
public Geo::GDAL::Dataset	Open (scalar name, scalar access= 'ReadOnly')
public Geo::GDAL::Dataset	OpenEx (scalar name, scalar open_flags=0, array reference allowed_drivers=undef, array reference open_options=undef, array reference sibling_files=undef)
public Geo::GDAL::Dataset	OpenShared (scalar name, scalar access= 'ReadOnly')
public scalar	PackCharacter (scalar DataType)
public scalar	PackedDMSToDec (scalar packed)
public array reference	ParseXMLString (scalar XML)
public method	Polygonize (Geo::GDAL::Band src, Geo::GDAL::Band mask, Geo::OGR::Layer out, scalar PixValField, hashref options, subref progress, scalar progress_data)
public method	PopFinderLocation ()
public method	PushFinderLocation (scalar path)
public list	RIOResamplingTypes ()
public method	RasterizeLayer (Geo::GDAL::Dataset ds, arrayref bands, Geo::OGR::Layer layer, scalar transformer, scalar arg, arrayref burn_values, hashref options, subref progress, scalar progress_data)
public method	ReprojectImage (scalar src_ds, scalar dst_ds, scalar src_wkt=undef, scalar dst_wkt=undef, scalar ResampleAlg='NearestNeighbour', scalar WarpMemoryLimit=0, scalar maxerror=0.0, subref progress, scalar progress_data)
public list	ResamplingTypes ()
public scalar	SerializeXMLTree (arrayref XMLTree)
public method	SetCacheMax (scalar Bytes)
public method	SetConfigOption (scalar key, scalar value)
public method	SieveFilter (Geo::GDAL::Band src, Geo::GDAL::Band mask, Geo::GDAL::Band dst, scalar threshold, scalar connectedness, hashref options, subref progress, scalar progress_data)
public scalar	VersionInfo (scalar request= 'VERSION_NUM')

Public Attributes
scalar	HelpTopic
	$driver->{HelpTopic}
scalar	LongName
	$driver->{LongName}
scalar	ShortName
	$driver->{ShortName}

Detailed Description

A raster format driver.

Definition at line 3676 of file all.pm.

Member Function Documentation

public list Geo::GDAL::Driver::Capabilities

(

)

Returns

A list of capabilities. When executed as a class method returns a list of all potential capabilities a driver may have. When executed as an object method returns a list of all capabilities the driver has.

Currently capabilities are: CREATE, CREATECOPY, DEFAULT_FIELDS, NOTNULL_FIELDS, NOTNULL_GEOMFIELDS, OPEN, RASTER, VECTOR, and VIRTUALIO.

Examples.

@all_capabilities = Geo::GDAL::Driver::Capabilities;
@capabilities_of_the_geotiff_driver = Geo::GDAL::Driver('GTiff')->Capabilities;

Code:

public Geo::GDAL::Dataset Geo::GDAL::Driver::Copy	(	scalar	name,
		scalar	src,
		scalar	strict = 1,
		hashref	options = undef
	)

Copy the files of a dataset.

Parameters

NewName	String.
OldName	String. Create a new Geo::GDAL::Dataset as a copy of an existing dataset.

Note

a.k.a. CreateCopy

Parameters

name
src	A Geo::GDAL::Dataset object.
strict
options	An anonymous hash of driver specific parameters.

Returns

a new Geo::GDAL::Dataset object.

Code:

public method Geo::GDAL::Driver::CopyFiles

(

)

Code:

public Geo::GDAL::Dataset Geo::GDAL::Driver::Create

(

hash

params

)

Create a GDAL dataset using this driver.

Note

a.k.a. CreateDataset

As a list the parameters are: Name, Width, Height, NumberOfBands, PixelDataType, Options

Create a new Geo::GDAL::Dataset

Parameters

params

named parameters: Name the name of the dataset (default is 'unnamed'). Width the width of the dataset (default is 256). Height the height of the dataset (default is 256). Bands number of bands in the dataset (default is 1). Type the data type of the pixels the dataset (default is 'Byte'). One of Geo::OGR::Driver::CreationDataTypes. Options creation options as a reference to a hash (default is {}).

Returns

a new Geo::GDAL::Dataset object.

Code:

public list Geo::GDAL::Driver::CreationDataTypes

(

)

Returns

a list of data types that can be used for new datasets.

Code:

public list Geo::GDAL::Driver::CreationOptionList

(

)

Returns

a list of options, each option is a hashref, the keys are name, type and description or Value. Value is a listref.

Code:

public method Geo::GDAL::Driver::Delete

(

scalar

name

)

Parameters

name

Code:

public method Geo::GDAL::Driver::Domains

(

)

Code:

public scalar Geo::GDAL::Driver::Extension

(

)

Returns

a suggested extension or extensions (e.g., ext1/ext2) for datasets.

Code:

public scalar Geo::GDAL::Driver::MIMEType

(

)

Returns

a suggested MIME type for datasets.

Code:

public scalar Geo::GDAL::Driver::Name

(

)

Returns

The short name of the driver.

Code:

public method Geo::GDAL::Driver::Rename	(	scalar	NewName,
		scalar	OldName
	)

Rename (move) a GDAL dataset.

Parameters

NewName	String.
OldName	String.

Code:

public scalar Geo::GDAL::Driver::TestCapability

(

scalar

cap

)

Test whether the driver has the specified capability.

Parameters

cap	A capability string (one of those returned by Capabilities).

Returns

a boolean value.

Code:

---

The documentation for this class was generated from the following file:

• all.pm