Class: GDAL::RasterAttributeTable

Inherits:
Object
  • Object
show all
Includes:
FFI::GDAL
Defined in:
lib/ffi-gdal/raster_attribute_table.rb

Constant Summary

Constants included from FFI::GDAL

FFI::GDAL::ALTER_ALL_FLAG, FFI::GDAL::ALTER_NAME_FLAG, FFI::GDAL::ALTER_TYPE_FLAG, FFI::GDAL::ALTER_WIDTH_PRECISION_FLAG, FFI::GDAL::AppDefined, FFI::GDAL::AssertionFailed, FFI::GDAL::CPLES_BackslashQuotable, FFI::GDAL::CPLES_CSV, FFI::GDAL::CPLES_SQL, FFI::GDAL::CPLES_URL, FFI::GDAL::CPLES_XML, FFI::GDAL::CPLES_XML_BUT_QUOTES, FFI::GDAL::CPLE_WrongFormat, FFI::GDAL::CPLErr, FFI::GDAL::CPLValueType, FFI::GDAL::CPL_ENC_ASCII, FFI::GDAL::CPL_ENC_ISO8859_1, FFI::GDAL::CPL_ENC_LOCALE, FFI::GDAL::CPL_ENC_UCS2, FFI::GDAL::CPL_ENC_UCS4, FFI::GDAL::CPL_ENC_UTF16, FFI::GDAL::CPL_ENC_UTF8, FFI::GDAL::CSLT_ALLOWEMPTYTOKENS, FFI::GDAL::CSLT_HONOURSTRINGS, FFI::GDAL::CSLT_PRESERVEESCAPES, FFI::GDAL::CSLT_PRESERVEQUOTES, FFI::GDAL::CSLT_STRIPENDSPACES, FFI::GDAL::CSLT_STRIPLEADSPACES, FFI::GDAL::FileIO, FFI::GDAL::GDALAccess, FFI::GDAL::GDALAsyncStatusType, FFI::GDAL::GDALColorInterp, FFI::GDAL::GDALDataType, FFI::GDAL::GDALMD_AOP_AREA, FFI::GDAL::GDALMD_AOP_POINT, FFI::GDAL::GDALMD_AREA_OR_POINT, FFI::GDAL::GDALPaletteInterp, FFI::GDAL::GDALRATFieldType, FFI::GDAL::GDALRATFieldUsage, FFI::GDAL::GDALRWFlag, FFI::GDAL::GDALTileOrganization, FFI::GDAL::GDAL_DCAP_CREATE, FFI::GDAL::GDAL_DCAP_CREATECOPY, FFI::GDAL::GDAL_DCAP_OPEN, FFI::GDAL::GDAL_DCAP_RASTER, FFI::GDAL::GDAL_DCAP_VECTOR, FFI::GDAL::GDAL_DCAP_VIRTUALIO, FFI::GDAL::GDAL_DMD_CREATIONDATATYPES, FFI::GDAL::GDAL_DMD_CREATIONOPTIONLIST, FFI::GDAL::GDAL_DMD_EXTENSION, FFI::GDAL::GDAL_DMD_EXTENSIONS, FFI::GDAL::GDAL_DMD_HELPTOPIC, FFI::GDAL::GDAL_DMD_LONGNAME, FFI::GDAL::GDAL_DMD_MIMETYPE, FFI::GDAL::GDAL_DMD_OPTIONLIST, FFI::GDAL::GDAL_DMD_SUBDATASETS, FFI::GDAL::GDAL_DS_LAYER_CREATIONOPTIONLIST, FFI::GDAL::GDAL_OF_ALL, FFI::GDAL::GDAL_OF_RASTER, FFI::GDAL::GDAL_OF_READONLY, FFI::GDAL::GDAL_OF_SHARED, FFI::GDAL::GDAL_OF_UPDATE, FFI::GDAL::GDAL_OF_VECTOR, FFI::GDAL::GDAL_OF_VERBOSE_ERROR, FFI::GDAL::GMF_ALL_VALID, FFI::GDAL::GMF_ALPHA, FFI::GDAL::GMF_NODATA, FFI::GDAL::GMF_PER_DATASET, FFI::GDAL::IllegalArg, FFI::GDAL::NoWriteAccess, FFI::GDAL::None, FFI::GDAL::NotSupported, FFI::GDAL::ODrCCreateDataSource, FFI::GDAL::ODrCDeleteDataSource, FFI::GDAL::ODsCCreateGeomFieldAfterCreateLayer, FFI::GDAL::ODsCCreateLayer, FFI::GDAL::ODsCDeleteLayer, FFI::GDAL::OGRAxisOrientation, FFI::GDAL::OGRDatumType, FFI::GDAL::OGRERR_CORRUPT_DATA, FFI::GDAL::OGRERR_FAILURE, FFI::GDAL::OGRERR_INVALID_HANDLE, FFI::GDAL::OGRERR_NONE, FFI::GDAL::OGRERR_NOT_ENOUGH_DATA, FFI::GDAL::OGRERR_NOT_ENOUGH_MEMORY, FFI::GDAL::OGRERR_UNSUPPORTED_GEOMETRY_TYPE, FFI::GDAL::OGRERR_UNSUPPORTED_OPERATION, FFI::GDAL::OGRERR_UNSUPPORTED_SRS, FFI::GDAL::OGRFieldType, FFI::GDAL::OGRJustification, FFI::GDAL::OGRNullFID, FFI::GDAL::OGRStyleToolClassID, FFI::GDAL::OGRStyleToolParamBrushID, FFI::GDAL::OGRStyleToolParamLabelID, FFI::GDAL::OGRStyleToolParamPenID, FFI::GDAL::OGRStyleToolParamSymbolID, FFI::GDAL::OGRStyleToolUnitsID, FFI::GDAL::OGRUnsetMarker, FFI::GDAL::OGR_Z_MARKER, FFI::GDAL::OGRwkbByteOrder, FFI::GDAL::OGRwkbGeometryType, FFI::GDAL::OGRwkbVariant, FFI::GDAL::OLCAlterFieldDefn, FFI::GDAL::OLCCreateField, FFI::GDAL::OLCCreateGeomField, FFI::GDAL::OLCDeleteFeature, FFI::GDAL::OLCDeleteField, FFI::GDAL::OLCFastFeatureCount, FFI::GDAL::OLCFastGetExtent, FFI::GDAL::OLCFastSetNextByIndex, FFI::GDAL::OLCFastSpatialFilter, FFI::GDAL::OLCIgnoreFields, FFI::GDAL::OLCRandomRead, FFI::GDAL::OLCRandomeWrite, FFI::GDAL::OLCReorderFields, FFI::GDAL::OLCSequentialWrite, FFI::GDAL::OLCStringsAsUTF8, FFI::GDAL::OLCTransactions, FFI::GDAL::ObjectNull, FFI::GDAL::OpenFailed, FFI::GDAL::OutOfMemory, FFI::GDAL::UserInterrupt, FFI::GDAL::VERSION, FFI::GDAL::VSI_STAT_EXISTS_FLAG, FFI::GDAL::VSI_STAT_NATURE_FLAG, FFI::GDAL::VSI_STAT_SIZE_FLAG, FFI::GDAL::WKB_25D_BIT

Instance Method Summary collapse

Methods included from FFI::GDAL

#CPLFree, #cpla_assert, find_lib, #gdal_check_version, gdal_library_path, search_paths, #srcval, #validate_pointer0, #validate_pointer1, #validate_pointer_err

Constructor Details

#initialize(raster_band, raster_attribute_table_pointer: nil) ⇒ RasterAttributeTable

Returns a new instance of RasterAttributeTable.

Parameters:

  • raster_band (GDAL::RasterBand, FFI::Pointer)
  • raster_attribute_table_pointer (FFI::Pointer) (defaults to: nil) 


10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/ffi-gdal/raster_attribute_table.rb', line 10

def initialize(raster_band, raster_attribute_table_pointer: nil)
  @raster_band = if raster_band.is_a? GDAL::RasterBand
    raster_band.c_pointer
  else
    raster_band
  end

  @gdal_raster_attribute_table = if raster_attribute_table_pointer
    raster_attribute_table_pointer
  else
    GDALGetDefaultRAT(@raster_band)
  end
end

Instance Method Details

#c_pointer ⇒ Object 



24
25
26
 
# File 'lib/ffi-gdal/raster_attribute_table.rb', line 24

def c_pointer
  @gdal_raster_attribute_table
end

#column_count ⇒ Fixnum

Parameters:

  • index (Fixnum) —

    The column number.

Returns:



30
31
32
 
# File 'lib/ffi-gdal/raster_attribute_table.rb', line 30

def column_count
  GDALRATGetColumnCount(c_pointer)
end

#column_of_usage(field_usage) ⇒ Fixnum

Returns The column number.

Parameters:

Returns:

  • (Fixnum) —

    The column number.



54
55
56
 
# File 'lib/ffi-gdal/raster_attribute_table.rb', line 54

def column_of_usage(field_usage)
  GDALRATGetColOfUsage(c_pointer, index)
end

#column_type(index) ⇒ GDALRATFieldType

Parameters:

  • index (Fixnum) —

    The column number.

Returns:



48
49
50
 
# File 'lib/ffi-gdal/raster_attribute_table.rb', line 48

def column_type(index)
  GDALRATGetTypeOfCol(c_pointer, index)
end

#column_usage(index) ⇒ GDALRATFieldUsage

Parameters:

  • index (Fixnum) —

    The column number.

Returns:



42
43
44
 
# File 'lib/ffi-gdal/raster_attribute_table.rb', line 42

def column_usage(index)
  GDALRATGetUsageOfCol(c_pointer, index)
end

#columnn_name(index) ⇒ String

Parameters:

  • index (Fixnum) —

    The column number.

Returns:



36
37
38
 
# File 'lib/ffi-gdal/raster_attribute_table.rb', line 36

def columnn_name(index)
  GDALRATGetNameOfCol(c_pointer, index)
end

#dump_readable(file_path = 'stdout') ⇒ Object

Parameters:

  • file_path (String) (defaults to: 'stdout') 


74
75
76
 
# File 'lib/ffi-gdal/raster_attribute_table.rb', line 74

def dump_readable(file_path = 'stdout')
  GDALRATDumpReadable(c_pointer, file_path)
end

#row_count ⇒ Fixnum

Returns The column number.

Parameters:

Returns:

  • (Fixnum) —

    The column number.



60
61
62
 
# File 'lib/ffi-gdal/raster_attribute_table.rb', line 60

def row_count
  GDALRATGetRowCount(c_pointer)
end

#to_color_table(entry_count = -1)) ⇒ GDAL::ColorTable

Parameters:

  • entry_count (Fixnum) (defaults to: -1)) —

    The number of entries to produce. The default will try to auto-determine the number.

Returns:



67
68
69
70
71
 
# File 'lib/ffi-gdal/raster_attribute_table.rb', line 67

def to_color_table(entry_count = -1)
  color_table_pointer = GDALRATTranslateToColorTable(c_pointer, entry_count)

  GDAL::ColorTable.new(@raster_band, color_table_pointer: color_table_pointer)
end