Документация

Classdef

LanAdapter класс начинается с ключевого слова classdef. classdef раздел определяет имя класса и указывает, что LanAdapter наследует от ImageAdapter суперкласс. Наследование от ImageAdapter позволяет новому классу:

Свойства

После classdef раздел, LanAdapter содержит два блока свойств класса. Первый блок содержит общедоступные, но не изменяемые свойства. Второй блок содержит полностью общедоступные свойства. LanAdapter сохраняет некоторую информацию из заголовка файла в качестве свойств класса. Другие классы, которые также наследуют от ImageAdapter, но которые поддерживают различные форматы файлов, могут иметь различные свойства.

classdef LanAdapter < ImageAdapter
   properties(GetAccess = public, SetAccess = private)
      Filename
      NumBands
   end

   properties(Access = public)
      SelectedBands
   end

В дополнение к свойствам, определенным в LanAdapter.m, класс наследует ImageSize свойство из ImageAdapter суперкласс. Новый класс устанавливает ImageSize свойство в конструкторе.

Методы: Конструктор классов

Конструктор класса инициализирует LanAdapter объект. LanAdapter конструктор анализирует информацию заголовка файла LAN и задает свойства класса. Реализовать конструктор, метод класса, внутри methods блок.

Конструктор содержит большую часть кода, используемого для синтаксического анализа заголовка файла LAN. LanAdapter класс поддерживает только uint8 файлы типа данных, поэтому конструктор проверяет тип пакета файла LAN, а также заголовок. Свойства класса хранят оставшуюся информацию. Метод, ответственный за считывание данных пикселей, использует эти свойства. SelectedBands свойство позволяет считывать подмножество областей данных с набором по умолчанию для чтения всех областей данных.

   methods

      function obj = LanAdapter(fname)
         % LanAdapter constructor for LanAdapter class.
         % When creating a new LanAdapter object, read the file
         % header to validate the file as well as save some image
         % properties for later use.
            
         % Open the file.
         obj.Filename = fname;
         fid = fopen(fname,'r');

         % Verify that the file begins with the headword 'HEADER' or
         % 'HEAD74', as per the Erdas LAN file specification.
         headword = fread(fid,6,'uint8=>char');
         if ~(strcmp(headword','HEADER') || strcmp(headword',...
               'HEAD74'))
            error('Invalid LAN file header.');
         end

         % Read the data type from the header.
         pack_type = fread(fid,1,'uint16',0,'ieee-le');
         if ~isequal(pack_type,0)
            error(['Unsupported pack type. The LanAdapter example ' ...
               'only supports reading uint8 data.']);
         end

         % Provide band information.
         obj.NumBands = fread(fid,1,'uint16',0,'ieee-le');
         % By default, return all bands of data
         obj.SelectedBands = 1:obj.NumBands;

         % Specify image width and height.
         unused_field = fread(fid,6,'uint8',0,'ieee-le');
         width = fread(fid,1,'uint32',0,'ieee-le');
         height = fread(fid,1,'uint32',0,'ieee-le');
         obj.ImageSize = [height width];

         % Close the file handle
         fclose(fid);

   end % LanAdapter 

Методы: Обязательные

Классы адаптеров имеют два обязательных метода, определенных в абстрактном суперклассе, ImageAdapter. Все классы адаптера образа должны реализовывать эти методы. blockproc функция использует первый метод, readRegion, для чтения блоков данных из файлов на диске. Второй метод, closeвыполняет необходимую очистку объекта Image Adapter.

   function data = readRegion(obj, region_start, region_size)
      % readRegion reads a rectangular block of data from the file.

      % Prepare various arguments to MULTIBANDREAD.
      header_size = 128;
      rows = region_start(1):(region_start(1) + region_size(1) - 1);
      cols = region_start(2):(region_start(2) + region_size(2) - 1);
 
      % Call MULTIBANDREAD to get data.
      full_size = [obj.ImageSize obj.NumBands];
      data = multibandread(obj.Filename, full_size,...
     'uint8=>uint8', header_size, 'bil', 'ieee-le',...
         {'Row',   'Direct', rows},...
         {'Column','Direct', cols},...
         {'Band',  'Direct', obj.SelectedBands});
 
   end % readRegion

readRegion имеет два входных аргумента, region_start и region_size. region_start аргумент, двухэлементный вектор в форме [row col]определяет первый пиксель в блоке запроса данных. region_size аргумент, двухэлементный вектор в форме [num_rows num_cols], определяет размер запрашиваемого блока данных. readRegion метод использует эти входные аргументы для считывания и возврата запрошенного блока данных из изображения.

readRegion способ реализуется по-разному для различных форматов файлов, в зависимости от того, какие инструменты доступны для чтения конкретных файлов. readRegion метод для LanAdapter класс использует входные аргументы для подготовки пользовательских входных данных для multibandread. Для файлов LAN multibandread предоставляет удобный способ чтения определенных подразделов изображения.

Другой требуемый метод: close. close способ LanAdapter класс появляется следующим образом:

      function close(obj)
      % Close the LanAdapter object. This method is a part
      % of the ImageAdapter interface and is required.
      % Since the readRegion method is "atomic", there are
      % no open file handles to close, so this method is empty.

      end
        
   end % public methods
    
end % LanAdapter

Как указано в комментариях, close способ для LanAdapter не имеет никакого отношения, так что close пуст. multibandread функция не требует обслуживания дескрипторов открытых файлов, поэтому close метод не имеет дескрипторов для очистки. Классы адаптера образа для других форматов файлов могут иметь более существенные значения close методы, включая закрытие дескрипторов файлов и выполнение других обязанностей по очистке классов.

Методы (необязательно)

Как написано, LanAdapter класс может только читать файлы LAN, но не записывать их. Если вы хотите записать выходные данные в файл формата LAN или другой файл с форматом, который blockproc не поддерживает, реализует опциональный writeRegion способ. Затем можно указать класс как 'Destination' параметр в blockproc и запишите выходные данные в файл выбранного формата.

Подпись writeRegion способ заключается в следующем:

function [] = writeRegion(obj, region_start, region_data)

Первый аргумент, region_start, указывает первый пиксель блока, writeRegion метод записывает. Второй аргумент, region_data, содержит новые данные, которые метод записывает в файл.

Классы, реализующие writeRegion метод может быть более сложным, чем LanAdapter. При создании объекта адаптера образа с возможностью записи классы часто несут дополнительную ответственность за создание новых файлов в конструкторе класса. Это создание файла требует более сложного синтаксиса в конструкторе, где потенциально необходимо указать размер и тип данных нового файла, который требуется создать. Конструкторы, создающие новые файлы, могут также столкнуться с другими проблемами, такими как права доступа к файлам операционной системы или потенциально трудный код создания файлов.